Skip to content

Options information:

Options section provide tables which contains configurable items from each section. It allows quick search for option to correctly configure it.

Tables have different formats to streamline only valuable information, so if requirements section is missing for example, assume there is no requirements. Have in mind that description may contain crucial information about correct format or if some extra requirements may apply.

The sections are:

  • Key - The key is field on GUI. There may be rows where key is missing - usually it's the things that are generated - like filename which is usually saved as "file" inside the configuration files.
  • Section - Used only in admin.md as it have a lot of sections which mostly are all saved to heimdall.conf file, shows which items belong to which admin subsection
  • Requirements - Shows requirements to see given option, if requirements are not fulfilled the field won't be set even if it used. If the requirement is just the name of the key: Enable Kerberos Authentication, it means the given key must be true. Otherwise, it's specified exactly in case of non-boolean values or if boolean value should be false.
  • Conf File field - Name of the key inside configuration file. The filename is always written above the table.
  • Description - Description of what given key does. There might be extra information about possible values or some restrictions.
  • Possible values - Value type that given key is using. There might be some restrictions like number should be non-negative.
  • Default - Default value of the given key if it's not set. Often configurable items don't have any default values which is shown as -.