Single key/value settings are overridden in the order above. Nested key/value pairs like Backends are merged.

ex.:

results in default_theme = Company

nested values:

results in

List values are concatenated.

ex.:

results in:

However, if you want to override a list value completely, you can reset the list by setting it to an empty value:

results in:

The thruk.conf contains the shipped defaults. You should not edit this file directly. Overwrite your settings in your thruk_local.conf / thruk_local.d/ instead.

Local settings drop directory. All *.cfg and \*.conf files in here override settings from the thruk.conf file. Besides the standard file extension cfg and conf it is also possible to use the hostname. Those files are only used if the hostname matches the actual system hostname. This is a good way to separate test and production configuration.

example:

The thruk_local.conf should contain all settings which are locally overridden. Keep the default settings in the thruk.conf and only put local overrides in either the thruk_local.conf or into conf file below thruk_local.d/.

This cgi.cfg is described here.

Menu customization is described here.

Logfiles are described here.

set the title prefix for all urls this piece of text will be prepended to all page titles.

ex.:

Sets the page title to the name of a bookmark if the url matches. Private bookmarks are processed first and the name of the first match is used.

ex.:

Uses more descriptive page titles. Bookmark titles take precedence and can be overridden by adding the title parameter on most pages

ex.:

Changes the usual url path for Thruk. Don’t change it unless you plan to run multiple Thruk instances on the same webserver. You will have to change your fastcgi configuration too.

ex.:

DEPRECATED use server_timezone now.

Changes the timezone from the systems default to this timezone. Only set this if you have trouble with displaying the right timestamps. Use /usr/share/zoneinfo on most linux systems for reference, as some timezones are set using the Region/Country format.

ex.:

Since users can change their timezone setting, this changes their default. Possible values are:

ex.:

Set to 1 to enable cluster features or 0 for single node setups.

ex.:

Define generic url pattern to connect all cluster nodes. Each cluster node must be available on the given address. 3 variables will be replaced to make this url generic: - $hostname$: hostname from hostname - $url_prefix$: contains the url prefix from url_prefix - $proto$: trying to autodetect either http or https, autodetect will only work with OMD and falls back to http otherwise.

ex.:

Set timeout after which a node is removed from the cluster.

ex.:

DEPRECATED: setting this has no effect with Thruk 2.34 or later.

The rest api is enabled by default, disabling it would break Thruk operation.

Using api keys can be disabled by setting this to 0. You cannot use api keys at all if this is disabled.

Note: this value cannot be overridden on a per user/group basis because it is used on pre-authentication stage. If you want users to not create new keys, use max_api_keys_per_user = 0.

ex.:

Limit amount of keys a user may create. Set to 0 to disable creating new keys completely

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later. Specify user agents which will be redirected to the mobile plugin (if enabled).

ex.:

Default theme to use for all users. Must be a valid sub directory in the themes_path folder.

ex.:

Default theme to use for if the user prefers a dark theme.

ex.:

Set first day of week. Used in reports. Sunday: 0 Monday: 1

ex.:

Large reports will use temp files to avoid extreme memory usage. With 'report_use_temp_files' you may set the report duration in days which will trigger the use of temp files. Default is 14days, so for example the 'last31days' report will use temp files, the 'thisweek' not. Can be disabled by setting to 0.

ex.:

Don’t create reports with more hosts / services than this number. The purpose is to don’t wrack the server due to extended memory usage. Increase this number if you hit that limit and have plenty of memory left.

ex.:

Include messages with class = 2 (program messages) in reports. Setting this to 0 allows the MySQL backend to use indexes efficiently

ex.:

Should thruk update the logcache databases before running reports? Setting this to 0 reduces the time taken to run reports but the most recent data is not necessarily available. If you use this option you should probably create a cron to run "thruk -a logcacheupdate"

ex.:

This link is used as startpage and points usually to the main.html with displays version information and general links.

ex.:

This link is used whenever you click on one of the main logos. By default those logos are the Thruk logos and the link will take you to the Thruk homepage. Replace this with where you want your home location to be.

ex.:

This sets how the home link is opened. By default this is set up open in a new tab (_blank).

ex.:

This link is used in the side navigation menu as link to the documentation. Replace with your documentation location. Set it to a blank value if you don’t want a documentation link in the menu at all.

ex.:

Customizable link for the 'problems' link in side menu. Can be useful to reflect your companies process of error handling.

ex.:

List of allowed patterns, where links inside frames can be set to. You can link to /thruk/frame.html?link=http://wiki.my-company.com/page/blah Your wiki will then be displayed with the Thruk navigation frame. Useful for other addons, so they don’t have to display a own navigation. Wildcards are allowed since v3.06.

ex.:

List of (target, regex) pairs. When Thruk generates links (for example for the action_url of a service) the URL is matched against the regex. If the regex matches the URL then the 'target' is used for the links target attribute. Target 'main' is special, if the link matches allowed_frame_links, it creates a link that is, when clicked on, opened inside a frame in Thruk. If it doesn’t match allowed_frame_links the target '_blank' is used.

ex.:

Maximum memory usage (in MB) at which a Thruk process will exit after finishing its request. Only affects the fcgid daemon.

ex.:

Timeout after which thruk -a graph fails. Defaults to 30.

Set this if a contact should be allowed to send commands unless defined for the contact itself. This is the default value for all contacts unless the user has a can_submit_commands setting in your monitoring configuration.

ex.:

Use this to disabled specific commands. Can be use multiple times to disabled multiple commands. The number can be found in the 'cmd_typ' cgi parameter from links to the command page. If you only want to allow a few commands, use command_enabled instead. You may use ranges here. If you want to disable all commands, you can use command_disabled = 0-999 or set the authorized_for_read_only role.

See a list of available commands along with their ids on the commands page.

ex.:

Enable only specific commands. Overrides command_disabled setting by only allowing a few specific commands and disabling all others. The syntax is the same as in command_disabled. When using command_enabled then all commands are disabled and only those from command_enabled can be used.

See a list of available commands along with their ids on the commands page.

ex.:

Convert authenticated username to lowercase.

ex.:

Convert authenticated username to uppercase.

ex.:

Convert authenticated username by regular expression. The following example removes everything after an @ from the authenticated username and 'user@domain' becomes just 'user'.

ex.:

When set to a true value, every contact will only see the hosts where he is contact for plus the services where he is contact for. When disabled, a host contact will see all services for this host regardless of whether he is a service contact or not.

ex.:

Allow specific hosts to bypass the csrf protection which requires a generated token to submit certain post requests, for example to send commands. Use comma seperated list or multiple configuration attributes. Wildcards are allowed.

ex.:

Disable the possibility for a user to change his password. Only works with htpasswd passwords. To make this work you have to set a htpasswd entry in the Config Tool section.

ex.:

Sets the minimum lenght a password must have for users changing their passwords. Admins still can change the password any way they want in the config tool. This just affects the user password reset.

ex.:

Show the basic auth user / password formular. Enabled when using cookie auth. You may want to set this to 0 if you only use oauth2 authentication. Set it to 2, if you want to only show the oauth2 authentication but also have a toggle button, which can display the basic auth login form as a fallback.

ex.:

The path to your cgi.cfg. See cgi.cfg for details.

ex.:

The path to your log4perl configuration file.

ex.:

verbosity / debug level same as setting THRUK_VERBOSE environment.

ex.:

Enable author tweaks. Same as setting THRUK_AUTHOR environment. Only required for development, disables caches, enables template strict mode and more.

ex.:

If a page takes longer to render than this amount of seonds, a profile will be logged. Set to 0 to disable logging completely.

ex.:

Set level of machine information send in bug reports.

Possible options: - prod contains release information (default) - full contains uname and release information - none no information

ex.:

Defines an optional seperate logfile with some extra audit relevant log entries. The different categories can be used to enable/disabled specific messages. The logfile can use strftime format pattern to for ex.: add the timestamp to the logfile.

ex.:

Path to your plugins directory. Can be used to specify different location for you Thruk plugins. Don’t forget to set appropriate apache alias or rewrite rules when changing the plugin path. Otherwise the static content from plugins is not accessible.

Example redirect rule for apache:

ex.:

Url to Thruks plugin registry. The url must supply a json data structure with a list thruk plugins. Can be specified multiple times.

ex.:

Path to your themes directory. Can be used to specify different location for you Thruk themes. Don’t forget to set appropriate apache alias or rewrite rules when changing the themes path. Otherwise the static content from your themes may not accessible.

ex.:

Path to the var directory. Thruk stores user specific date here.

ex.:

Path to a temporary directory. Defaults to /tmp if not set and usually this is a good place.

ex.:

The path to your ssi (server side includes) files. See Server Side Includes for details.

ex.:

Specify a additional directory for user supplied templates. This makes it easy to override thruks own templates. Template search order is:

ex.:

Changes the path to your logo images. Default is $url_prefix+'thruk/themes/'$current_theme'/images/logos/' and therefor relative to the current selected theme. You could set a fixed path here. Like usual, paths starting with a / will be absolute from your webserver root directory. Paths starting without a / will be relative to the cgi directory.

ex.:

Location of your logos in your filesystem. This directory should be mapped to your 'logo_path_prefix' directory where 'logo_path_prefix' is the path relative to your webserver root directory and 'physical_logo_path' is the corresponding filesystem path.

ex.:

Mode used when creating or saving files.

ex.:

Mode used when creating folders

ex.:

Set a general resource file. Be warned, if any macros contain sensitive data like passwords, setting this option could expose that data to unauthorized user. It is strongly recommended that this option is only used if no passwords are used in this file or in combination with the 'expand_user_macros' option which will limit which macros are exposed to the user. Instead of using a general 'resource_file' you could define one file per peer in your peer config.

ex.:

maximum number of allowed search boxes

ex.:

Search long_plugin_output in default search, ex. from the side navigation. It is enabled by default, but can have significat performance impact in larger setups.

ex.:

The default_service_filter set a default service filter which is used when no other filter is applied (except from links to hosts or groups). The filter is negated by a leading exclamation mark. The example filters out all services starting with "test_". You can use regular expressions. The Default is not set.

ex.:

The default main filter can be use to apply a filter to the "All Hosts" view on the main landing page. You can use a special variable $REMOTE_USER$ which will be replace by the current user. The following example will apply a filter on the contact with the current user name, so the dashboard will show only hosts/service where the user is contact for, even if the user has global admin permissions.

ex.:

Exclude some hostgroups from the top 5 list on the "Home" page. The values can be regular expressions.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later.

Using the pager will make huge pages much faster as most people don’t want a services page with 100.000 services displayed. Can be disabled if you don’t need it.

ex.:

Define the selectable paging steps. Use the * to set the default selected value.

ex.:

Just like the paging_steps, but only for the groups overview page.

ex.:

Just like the paging_steps, but only for the groups summary page.

ex.:

Just like the paging_steps, but only for the groups grip page.

ex.:

Cut off objects on problems page, set 0 to disable limit completely. Defaults to 500.

ex.:

Set default for showing main data table at full size or not.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later. Change path to your host action icons. You may use relative paths to specify completely different location. You also may want to use 'action_pnp.png' when using pnp. Icon can be overridden by a custom variable '_ACTION_ICON'.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later. Change path to your service action icons. You may use relative paths to specify completely different location. You also may want to use 'action_pnp.png' when using pnp. Icon can be overridden by a custom variable '_ACTION_ICON'.

ex.:

Set initial menu state.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later.

Set whether you want to use a framed navigation or not. With using frames it’s sometimes easier to include addons. See allowed_frame_links option for how to integrate addons.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later.

Width of the navigation frame in px.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later.

Show the new split command box on the host / service details page.

ex.:

what email address bug reports will be sent to

ex.: bug_email_rcpt = bugs@thruk.org

Default timeformat. Use POSIX format.

ex.:

Default long timeformat.

ex.:

Default log timeformat.

ex.:

Default trends timeformat.

ex.:

Default timeformat for todays date. Can be useful if you want a shorter date format for today.

ex.:

DEPRECATED: setting this has no effect with Thruk 3.x or later.

DEPRECATED: setting this has no effect with Thruk 3.x or later.

Display the current number of notification after the current / max attempts on the status details page.

ex.:

List of default columns on host details page. Determines which columns and the order of the displayed columns. See an example on the Dynamic Views page.

ex.:

List of default columns on service details page. Determines which columns and the order of the displayed columns. See an example on the Dynamic Views page. Use ex.: peer_name:site to always show the site name column or optional only if there is more than one backend with the ? as in peer_name?:site.

ex.:

List of default columns on overview details page. Determines which columns and the order of the displayed columns. See an example on the Dynamic Views page.

ex.:

List of default columns on grid details page. Determines which columns and the order of the displayed columns. See an example on the Dynamic Views page.

ex.:

Display the backend/site name in the status table. This is useful if you have same hosts or services on different backends and need to know which one returns an error. Valid values are:

ex.:

Show links to config tool for each host / service. You need to have the config tool plugin enabled and you need proper permissions for the link to appear.

ex.:

For historical reasons (there was no explicit admin role in the past) any user with both, the - authorized_for_system_commands and - authorized_for_configuration_information gains the full admin role as well. This behaviour can be disabled with this admin_role_from_system_and_conf switch. This is deprecated and the default will change in a future release.

Display the full command line for host / service checks . Be warned, the command line could contain passwords and other confidential data. In order to replace the user macros for commands, you have to set the 'resource_file' in your peer config or a general resource_file option.

ex.:

Replace pattern for expanded command lines. Could be used to replace sensitive information from being displayed in the gui. The pattern is a simple perl regular substitute expression in the form of '/pattern/replacement/'

ex.:

Another way is to create a _OBFUSCATE_REGEXP custom variable which will then be used for its host/service. The syntax is slightly different, you only set the regexp pattern which will be replaced:

ex.:

The password can be base64 encoded to mitigate escaping issues. Encode the regexp and add the b64: prefix.

then use this in your naemon configuration:

If regular expressions are not required, you can use the _OBFUSCATE_STRING custom variable. This is a simple text replacement with no regular expressions. This also supports the optional base64 encoding.

ex.:

Usually the source of your expanded check_command should be the check_command attribute of your host / service. But under certain circumstances you might want to use display expanded commands from a custom variable. In this case, set 'show_full_commandline_source' to '_CUST_VAR_NAME'.

ex.:

Show additional logout button next to the top right preferences button. (works only together with cookie authentication)

ex.:

Change url of logout link. Might be useful in combination with oauth.

ex.:

When a plugin returns more than one line of output, the output can be displayed directly in the status table, as popup or not at all. Choose between popup, inline and off

ex.:

Color complete status line with status colour or just the status itself.

ex.:

Show if a host / service has modified attributes.

ex.:

Show host / service contacts. User must have the configuration_information role.

ex.:

Seconds after which the "is_executing" icons disappear.

ex.:

Show check attempts for hosts too. The default is to show them on the problems page only. Use this value to force a value.

ex.:

Define pattern to be replaced with links in comments, downtimes and plugin output.

Syntax is: | regex pattern | [link name](link target) |

Can be set multiple times.

Simple links and markdown style links will be replaced automatically. So links in the form:

will just work. No need to disabled escape_html just to show some links.

ex.:

Replaces the string "INC12345" with the link:

Replaces the string "GH#123" with the link:

Define pattern to be replaced with copy / paste buttons in the plugin output.

Syntax is: (pre text regex pattern)(link text regex pattern)(post text regex pattern)

Can be set multiple times.

ex.:

This option enables a performance bar inside the status/host list which create a graph from the performance data of the plugin output. Available options are 'match', 'first', 'all', 'worst' and 'off'.

ex.:

Show pnp popup if performance data are available and pnp is used as graph engine. The popup will be available on the performance data bar chart on the right side of each host/service. It uses the normal pnp popup logic, so you need to install the proper SSI files.

ex.:

If set, a Internet Explorer (IE) compatibility header will be added to the html header.

Defines the order to determine the worst/best states. Used in business processes and the panorama dashboard. Can be overridden in those plugins.

ex.:

Show inline pnp graph if available. If a service or host has a pnp4nagios action or notes url set. Thruk will show a inline graph on the extinfo page. This works for /pnp4nagios/ urls and /pnp/.

ex.:

graph_word is a regexp used to display any graph on the details page. if a service or host has a graph url in action url (or notes url) set it can be displayed by specifying a regular expression that always appears in this url. You can specify multiple graph_words.

sample service configuration for graphite:

ex.:

graph_replace is another regular expression to rewrite special characters in the url. For example graphite requires all non-word characters replaced by underscores while graphios needs spaces removed too. You can use this setting multiple times.

sample service configuration for graphite:

sample service configuration for graphios:

The http_backend_reverse_proxy will proxy requests for pnp or grafana action_urls via the http backend if possible. This only works for http backends and if cookie auth is enabled. Can be used to proxy thruk nodes (experimental)

Possible options: - 0 disabled - 1 enabled

ex.:

Show custom vars in host / service ext info. List variable names to display in the host and service extinfo details page. Can be specified more than once to define multiple variables. You may use html in your variables. Use * as wildcard, ex.: _VAR* To show a host custom variable for services, prepend _HOST, ex.: _HOSTVAR1. To show all host variables in the service view, use wildcards, ex.: _HOST* Host variables are only used with HOST*, not by * alone, see examples.

ex.:

Expose custom vars sets a list of custom variables which is safe for all users/contacts to view. They will be used in filtering and column selection as well as in json result sets. Basically they will be handled the same way as show_custom_vars except they will not be displayed automatically. Syntax is the same as show_custom_vars.

ex.:

Expand user macros ($USERx$) for host / service commands and custom variables. Can be specified more than once to define multiple user macros to expand. Be warned, some user macros can contain passwords and expanding them could expose them to unauthorized users. Use * as wildcard, ex.: USER*

Defaults to 'ALL' which means all user macros are expanded, because its limited to admin users anyway.

ex.:

Show link to bug reports when internal errors occur. Set to '1' to show a error icon which links to a error report mail. Set to 'server' to log js error server side. Set to 'both' to log server side but still show the icon.

ex.: show_error_reports = both

don’t report some known harmless javascript errors

ex.: skip_js_errors = cluetip is not a function

Normally passive checks would be marked as disabled. With this option set, disabled checks will only be displayed as disabled if their last result was active. Otherwise they would be marked as passive checks. This option also changes the passive icon only to be shown when the last check was passive, otherwise the disabled icon will be displayed.

ex.:

Normally passive checks whould be displayed with a passive icon if their last result is passive. With this option, passive icon will be hidden in status details.

ex.:

hide_top sets the default value for showing/hiding the totals header on status pages. It can be set to one of:

ex.:

The sitepanel is used to display multiple backends/sites at a glance. With than 10 or more sites, the list of backends will be combined into the 'compact' site panel which just displays the totals of available / down / disabled sites. The 'compact' panel will also automatically be used if you use sections. With more than 50 backends, the 'collapsed' panel will be selected in 'auto' mode. With more than 100 backends, the 'tree' panel will be selected in 'auto' mode. Set sitepanel to list/compact/collapsed/tree/auto/off to change the default behaviour.

ex.:

You can integrate the output of apache status into Thruk. The following list of apache status pages will be accessible from the performance info page. Make sure the page is accessible from Thruk, credentials will be passed through. So both, basic authentication or ip based authentication would be possible. Read more about Apaches mod_status here: http://httpd.apache.org/docs/current/mod/mod_status.html

ex.:

DEPRECATED: please use LMD when using multiple backends.

Set logging of backend in verbose mode. This only makes sense when debug logging is activated.

ex.:

Use connection pool when accessing multiple sites. Increases the performance because backends will be queried parallel but uses around 10mb of memory per pool member. Disabled when set to 0, number of concurrent connections otherwise.

ex.:

Enable lmd connection handling. Set to 1 to enable. LMD handles all backend connections in a separate process which will be started automatically with thruk if enabled. Read more on lmd at: https://github.com/sni/lmd or here LMD.

ex.:

Path to lmd binary.

ex.:

Path to additional lmd configuration. The sites will be automatically generated. Can be used multiple times.

ex.:

Set some extra command line options when starting lmd.

ex.:

Thruk waits this timeout for lmd to respond, otherwise it gets killed and restarted. Set to 0 to turn off automatic restarts (it will still be started if it is not running).

ex.:

Instead of using LMD managed by Thruk, you can run your own LMD and let Thruk use that one instead

ex.:

Enables caching logfiles for faster access and less memory usage for the naemon process. Cache supports only Mysql. Prefered type is Mysql. Format is a Mysql connection string like 'mysql://hostname:port/db'. Using a cache dramatically decreases cpu and memory usage of Thruk and Naemon when accessing logfiles, for example when creating reports.

ex.:

Define filter which prevents the logcache from overgrowing with useless log messages. Since the main reason for the logcache are availability reports it is ok to remove some entries. Can be used multiple times.

ex.:

This option enables/disables the delta updates of the logcache whenever somebody opens a page which requires logfiles, ex.: the showlog page. This improves the responsiveness of the page but you miss the latest log entries since the last manual update.

ex.:

When having multiple sites, you can change the number of parallel updates with the logcache_worker option. Setting worker number to 1 disables parallel execution.

ex.:

Default duration when running thruk logcache clean. See the time definitions page for available options.

ex.:

Default duration when running thruk logcache compact. Compact removes duplicate alerts having the same state. It also removes basically everything not required for sla reports and keeps a few extras like notifications.

ex.:

Define wether logcache will be bypassed if the start / end time of a log querys is outside the range of the cache.

ex.:

The import command replaces the builtin logcache update with an external script which is then responsible for updating the logcache database. This might be useful if you pull the logfiles from a ndo/ido database and then manually import those files.

There are some useful enviromenet variables set before the script is started:

ex.:

The fetchlogs command is very similar to the logcache_import_command but it replaces only the the fetching logs part from the bultin logcache. This script should return the plain text logfiles on stdout (standard naemon/nagios logfile format). This might be useful if you pull the logfiles from a ndo/ido database.

See ./support/icinga2_ido_fetchlogs.sh for an example.

There are some useful enviromenet variables set before the script is started to control which logs should be fetched:

ex.:

If you are using a mysql database with galera replication such as MariaDB Cluster, Percona XtraDB Cluster or Galera Cluster it is a good idea to avoid locks and optimize/repair table statements since they are not properly replicated.

Especially in Percona XtraDB Cluster > 5.6 the default setting of pxc_strict_mode will disable locks all togheter.

This setting will make the logcache work in that case. More information about pxc_strict_mode available here: - Percona documentation

ex.:

Delay the page delivery until the backends uptime is at least this amount of seconds. Displaying pages soon after backend restarts may display wrong results and all services are pending. Enable this if you experience problems with pending services after reloading your backend. Should be obsolete with Livestatus versions greater than 1.2 ex.: setting this to 10 would start serving pages 10 seconds after the backend reload

ex.:

Can be set to enable / disable hostname verification for https connections. For example for the cookie login, https backends or oauth requests. It is not recommended to disabled hostname verification, set ssl_ca_path or ssl_ca_file instead.

ex.:

Sets path to your certificates. Either set ssl_ca_path or ssl_ca_file. Not both. Defaults to ssl_ca_file = Mozilla::CA::SSL_ca_file() if Mozilla::CA perl module is installed or ssl_ca_path = '/etc/ssl/certs' otherwise.

ex.:

Sets path to your ca store. See ssl_ca_path for details.

ex.:

Specifies the url where non-authenticated users will be redirected too.

ex.:

Specifies the url against the cookie auth provider will verify its credentials.

ex.:

Specifies the timeout for idle sessions. Session will be removed if not used within this timeperiod.

ex.:

Specifies the amount of seconds in which subsequent requests won’t verify authentication again. Set to zero to disable storing encrypted credentials in the filesystem and disabling revalidation of active sessions (sessions will never invalidate).

ex.:

Just like successful logins are cached for a few seconds (cookie_auth_session_cache_timeout), failed logins are cached as well to prevent denial of service attacks with invalid credentials. cookie_auth_session_cache_fail_timeout sets the amount of seconds to cache failed logins. Set this to zero disabled invalidation of the cache.

ex.:

Timeout for internal sub request on authentication url. Defaults to 10 seconds and can be disabled by setting it to zero.

ex.:

Cookie domain is usually set automatically. Use this option to override the default value. Domains have to contain at least two periods. Useful for single sign on environments.

ex.:

Hook script which is called on every successful login. The REMOTE_USER environment variable will be set to the username of the current logged in user. Useful to do magic stuff on each login. The REMOTE_USER_GROUPS environment variable contains semicolon separated list of contactgroups. THRUK_REQ_URL contains the current url. Available standard environment variables are listed on the CLI Environment page.

ex.:

Disable account after this number of failed login attempts. This feature will be disabled if set to zero.

Default: 10

ex.:

The error message when an account is locked, may contain html.

ex.:

Increase logging of cookie authentication related things. This usually gets printed to the apache error log.

Default: 0

ex.:

Set oauth (oauth2) authentication provider

ex.:

Set the default checked state for command options.

ex.:

Forces acknowledgments to be sticky.

ex.:

Forces sending a notification for acknowledgments.

ex.:

Forces comments on acknowledgments to be persistent.

ex.:

Forces normal comments to be persistent.

ex.:

Default duration of new downtimes in seconds. Default is 2 hours.

ex.:

Maximum duration of new downtimes. Use quantifiers like d=days, w=weeks, y=years to set human readable values. Default is unlimited.

ex.:

Show expire acknowledgement form.

ex.:

Default duration of acknowledgements with expire date. Default is one day.

ex.:

Default spread of rescheduled checks in seconds. Default is none. Options are 0, 10, 30, 60, 300, 900, 1800, 3600.

ex.:

Configure which commands should be available as quick status commands.

ex.:

When you want to reschedule passive checks for which the result is fetched by an agent (For example check_mk or some scenarios of check_multi). You usually want to reschedule the agent instead of the passive check.

The command reschedule alias can be used to translate the reschedule command from the passive service to the active agent service.

In this example, all passive check_mk checks will trigger the active agent check and therefor allow you to reschedule passive checks directly from the problems page.

ex.:

Use recurring downtime, shows recurring downtime links.

ex.:

Use service’s description instead of display name. DEPRECATED use service_description_source instead.

ex.:

Set alternative source of host name display. Listed attributes will be tried in given order and first non-empty value wins. Custom variables are possible ex.: _NAME, name will first try the _NAME custom variable and use the host.name as fallback. Useful attributes are ex.: name, alias, address, display_name or custom variables

Note: hosts will always be ordered by host_name

ex.:

Set alternative source of service description display. Listed attributes will be tried in given order and first non-empty value wins. Custom variables are possible ex.: _NAME, description will first try the _NAME custom variable and use the service.description as fallback. Useful attributes are ex.: description, display_name or custom variables

Note: services will always be ordered by description.

ex.:

Use trends, shows trend links.

ex.:

Waiting is a livestatus feature. When enabled, Thruk will wait after rescheduling hosts/services checks until the check has been really executed up to a maximum of 10 seconds. Adjust the time waiting with the 'wait_timeout' option.

ex.:

Amount of seconds to wait until a rescheduled check finishes. Thruk will wait this amount and display the result immediately.

ex.:

If set to 1, the user has to enter a comment for all disable active checks / disable notifications / disable event handler commands. These comments are automatically prefixed with the command name and will be deleted when checks / notifications / handlers are enabled again. They are also used by the 'reenable_actions' utility.

ex.:

Specify a file which is then completely under the control of Thruk. It will be used to store cronjobs, ex. for reports. The file has to be writable by Thruk.

ex.:

The pre edit cmd can be used to do run a command just before Thruk will edit the crontab.

ex.:

The post edit cmd is necessary for OMD where you need to reload the crontab after editing or for replacing the users cron with the edited file.

ex.:

Path to your thruk executable. Will be used in cronjobs.

ex.:

Defines the menu used by placeholders from the '_THRUK_ACTION_MENU' custom variable. The menu is a key/value pair with the name and the menu description in json format. The menu can either be a single icon/menu or a list of menus and icons.

A simple menu could look like this, note that the menu has to be in a single line without newlines and all newlines from the example have to be removed in order to try that. But its more readable this way. You can also use a trailing backslash to write the menus on multiple lines.

Sample menu with two items and a seperator:

A menu has the following attributes:

A single "-" item can be used as a menu item seperator.

The menu item can have the following attributes:

Organize action_menu_items in a folder. Each file in this folder will be read as action menu.

This folder may also contain .js files since version 2.24.

Both examples are equivalent and result in the same menu assuming there is a /etc/thruk/action_menus/hostmenu.json file.

With apply rules adding action menus is made easy and independant from the actual object configuration. You can setup a few regular expression rules which then add the corresponding action menu to matching hosts and services. The syntax is menu_name = Hostpattern;Servicepattern

ex.:

Defines the available server commands from action_menu_items. Key/Value pair of the name of the script and the corresponding command. The command has to be a full path program and not just a shell command. Therefor you do not have to use quotes because the arguments are not interpreted by a shell before execution due to security reasons.

It is possible to use most standard Macros and the username is available in the REMOTE_USER environment variable.

ex.:

This one activates all icinga specific features. If not set, Thruk will try to auto-detect your backends. Currently auto detection will only work within OMD. Don’t enable it unless all your backends are icinga.

ex.:

This one activates all problem/impact and criticity features. Currently it will only work with shinken backends. Don’t enable it unless all your backends are shinken. If not set, it will be automatically enabled when using only shinken backends.

ex.:

Set the names of the priority (criticity in shinken). Currently this will only work with shinken backends.

ex.:

Normally reports will be generated in an external process to avoid timeouts on long running reports. Use this switch to turn external jobs off and generate reports directly. Make sure they are finished within 40seconds which is the default fcgi timeout.

ex.:

Path to your thruk init script. Will be used to restart thruk.

ex.:

Path used for cookies. Do not change unless you have weird url rewrites which breaks setting cookies.

ex.:

Sets all cookies with secure=1 if enabled.

ex.:

ex.:

Enable/Disable the plugin syntax helper. When enabled, Thruk will run the plugins with "plugin -h" to get the help information.

Path to your thruk_local.conf. Enables adjusting Thruks config if set.

Path to your cgi.cfg. Enables adjusting the cgi.cfg if set.

Path to your htpasswd. Enables user management based an Apaches basic auth with htpasswd.

Run a command before saving object config files. Save will be canceled if the command returns non-zero exit code. Command will be run with 'pre' as first argument and the root config folder as second argument.

The following environment variables will be set:

Run a command after saving object config files. Command will be run with 'post' as first argument and the root config folder as second argument.

An example can be found in 'examples/config_tool_git_checkin'.

The following environment variables will be set:

If not all config folders are managed by git, then you can specify a directory which is used to display the history. Should point to a directory which is part of a git repository. This config setting is only used for the history support in the configuration tool. The 'git_base_dir' may be overridden by an per backend value.

Thruk will show a prompt to input a change summary if a 'post_obj_save_cmd' is set. You can use this option to suppress that prompt.

DEPRECATED: please use the editor plugin now.

Specify some extra files which can then be edited by the Thruk configtool text editor. Can be used multiple times. When used with a directory, all files below can be edited.

Extra custom variable attribute for hosts which will be available in the dropdown list when editing a host. Can be used multiple time and accepts comma separated lists.

Extra custom variable attribute for services which will be available in the dropdown list when editing a service. Can be used multiple time and accepts comma separated lists.

Use obj_readonly regular expressions which will be appended to the backend specific readonly patterns from the Component Backend peer configtool. The same effect can be achieved by adding "# thruk: readonly" on top of a object config file. Readdetails on the configtool section.

Space separated list of default attributes when creating a new host. Can contain custom variables like _VAR. Append default value separated by a :. This obviously means you cannot use spaces or colons in attributes or default values.

ex.:

see default_keys_host.

see default_keys_host.

Contains a comma seperated list of dashboards you want to show by default.

Make panorama dashboard readonly. The user cannot add, remove or change panels and tabs. Commands may still be send according to the user permissions.

Make panorama dashboard ignore changes. The user is allowed to change some parts of the layout, but nothing is saved. Commands may still be send according to the user permissions.

Full page reload every 3 hours to prevent memory leaks. Disabled when set to 0.

Normally new files start at index 1 but this can be changed here. This helps in situations when more than one Thruk installation has to create dashboards in the same folder.

Defines the order to determine the worst state for filter and group icons. Use this to override the global default_state_order.

Sets the default text when setting dashboards into maintenance mode. You can use html to format the text.

Default coordinates (lon,lat) for new geo maps.

Default zoom level for new geo maps.

WMS provider serve map tile data for geo maps according to http://dev.openlayers.org/docs/files/OpenLayers/Layer/WMS-js.html#OpenLayers.Layer.WMS.OpenLayers.Layer.WMS Find more wms provider here: http://wiki.openstreetmap.org/wiki/WMS#OSM_WMS_Servers

Properties can be set according to: http://dev.openlayers.org/docs/files/OpenLayers/Layer-js.html Some common properties are: attribution or numZoomLevels.

Comma separated list of additional fonts which will be listed in the text label drop down selection.

Execute regular scheduled reports with this nice level.

Maximum number of reports running at a time. If more reports are started, then they will be queued up. Default is 2.

Url used to replace relative links in html reports.

phantomjs is deprecated and no longer use. It has been replaced with puppeteer. See the FAQ for further information.

pnp_export defines a script which exports a PNP4nagios graph into a local file which then can be included in reports. PNP4nagios images are either exported localy by executing php or remotly fetched with wget. This works automatically in OMD, but only for local sites of course. To make this work without OMD, set the variable 'PNP_ETC' and 'PNP_INDEX' in the ~/.thruk file of your webserver. The PNP4nagios url is taken from the action url or from the notes url.

ex.:

Remote PNP4nagios graphs will be fetched by wget and usually the graphs are password protected, so you may want to set a different wget command to specify a username and password. This can to be set by the 'PNP_WGET' variable in the ~/.thruk file of the webserver user. You may force to use wget by setting 'PNP_URL_PREFIX'.

ex.:

Override default script for exporting grafana graphs to png with grafana_export.

Set the from address used in e-mail reports. Format is "User Name <example@mail.com>"

Set the default template used for new reports.

You may change the default map type of the statusmap here. Valid types are: 'table' and 'circle'

And the statusmap default group by which has to be one of: 'parent', 'address', 'domain', 'hostgroup', 'servicegroup'

You may change the default minemap link here.

Results will be send back by using the spool folder. This folder should point to the 'check_result_path' of your core.

As alternative to the spool_dir, a livestatus connection can be used to send results to the core. Set the name or key of the backend with this option.

Use this backend to store the actual objects. Must be a backend of type http.

Save objects to this file. Content will be overwritten.

File format of the saved objects. Valid formats are 'nagios' and 'icinga2'.

User maintained file containing templates used for business process services.

Command to apply changes to the objects_save_file.

Run this hook command before saving a business process. Along with the default environment variables set, there are two extra variables set which can be used:

Run this hook command after saving a business process. The same environment variables will be used as in the pre_save_cmd, except stage is set to 'post'.

Run this hook command after refreshing business processes is completed. Ex.: after every cron run of thruk bp all.

Refresh interval defines how often business processes will be recalculated and refreshed. (in minutes).

Automatic bp calculations will be disabled if set to zero.

Favorite custom function will be displayed on the 'Type' tab so you don’t have to select custom first. Syntax is <name>;<function>

Set the number of parallel business process calculations. Setting it to 1 disables parallelization. Setting it to 0 trys to autodetect a suitable value.

Automatic bp calculations will be disabled if set to zero.

Set the time (in seconds) how long a business process will wait for offline backends to recover. During this time the business process will keep its last known state.

Default is 180 seconds.

Decide how to handle offline backends in business processes. Valid values are:

Add global filter to all business processes, can be set multiple times.

Defines the order to determine the worst state for worst/best aggregations. Use this to override the global default_state_order.

Set downtime/acknowledgement for business process if all child nodes are in downtime/acknowledged. Valid values are:

(does not work in combination with spool_dir)

Make all bp related pages readonly.

Choose which tab should be displayed by default. Only useful if several http backends are in use.

Valid values are:

The groups directive overrides specific config settings for one group only. Group overrides are applied in alphabetical order. For example, if you have a user in group 'Admins' and in 'Superadmins', he will get all overrides from both groups, but the 'Admins' overrides will be superseded by the 'Superadmins'.

ex.:

The users directive overrides specific config settings for one user only.

ex.: