User Tools

Site Tools


  Main   About   Help   Download
nconf:help:documentation:detail:general_configuration

General configuration options

The following configuration options are available under config/nconf.php:

URLs / paths

NCONFDIR

This is the directory where NConf is located. The install script should fetch the correct path.

  • This option must be defined during installation.
Default value: "/var/www/nconf"

URLROOTPATH

Obsolete as of NConf 1.2.5

This is the path from the webservers “DOCUMENT_ROOT” to the NConf directory. It's used to control the URL accessibility (restrictions for users).

Example: If your URL is http://www.mydomain.com/nconf/ then set 'URLROOTPATH' to '/nconf/'.

IMPORTANT: This option must always end with a '/' !

OS_LOGO_PATH

This is the path to the directory with the OS logo icons.

Default value: "img/logos"

NAGIOS_BIN

This is the path to the Nagios binary. The binary is needed in order to run tests on the generated config. It is highly recommended to make NConf run these checks. NConf will not work properly if these checks cannot be executed. This path should either point to the original binary (if Nagios is installed on the same host), to a copy of the binary (copy it to the bin/ folder), or to a symbolic link. Make sure the binary is executable to the webserver user.

  • This option must be defined during installation.
Default value: "/var/www/nconf/bin/nagios"

CHECK_UPDATE

When enabled, NConf will access http://update.nconf.org and will display information about the latest available version. This is done over your browser, so the server where NConf is running on does not need Internet access. NO information about your environment and NO NConf related info will be sent or made available to others!
If you don't want NConf to check for updates, you can disable it by setting CHECK_UPDATE to “0”.

Possible values: "0", "1"
Default value:   "1"


Design template

TEMPLATE_DIR

This defines which design-template (skin) to use. There is currently one predefined template which you can choose from.

Add more templates

You can clone a template folder within the design_templates folder and then modify the main.css file, replace color values to get other style, but:

Changes pending

We will make some modifications to the template schema, so the new.css and ownstyle.css will be deleted and merged to main.css

The handling of design-templates is not final yet! For templates in general it's better to wait on a later release !!! We do not recommend to make your own style yet, later releases of NConf might perhaps not work with your copy!

Debug / safe mode

DEBUG_MODE

Displays detailed debug information at the bottom of the page.

Mainly used by developers for debugging, lots of query information will be visible.

If generating the config fails and DEBUG_MODE is enabled, the faulty configuration which was generated is saved to the nconf/output directory as NagiosConfig_FAILED.tgz. This can be useful for debugging.

Possible values: "0", "1"
Default value:   "0"

DEBUG_GENERATE

Optional: Displays detailed debug information while generating the configuration.

Possible values: "1" = ERROR, "2" = WARN, "3" = INFO, "4" = DEBUG, "5" = TRACE
Default value:   "3"

DB_NO_WRITES

This option should block modifications to the database (experimental). This should be disabled, otherwise the tool won't add, modify or delete entries. Viewing information should work, but it's not been tested in detail. Use this option with CAUTION!

Possible values: "0", "1"
Default value:   "0"

REDIRECTING_DELAY

This defines how many seconds to wait on auto redirects.

Used mostly after adding, modifying or deleting an item.

Possible values: numeric value
Default value:   "1"


Config deployment

NConf offers multiple possibilities to remotely deploy your generated configuration. A detailed description of all supported protocols and configuration options can be found in the deployment section.

ALLOW_DEPLOYMENT

This is a general switch to enable / disable config deployment.
If deployment is disabled, the generated config will simply remain in the 'output' directory.

Default value: "1"

Obsolete as of NConf 1.3
CONF_DEPLOY_URL
CONF_DEPLOY_USER
CONF_DEPLOY_PWD


Static file editor

$STATIC_CONFIG

List of folders containing additional files that you would like to make editable within NConf (basic text editing). We call these files 'static files', because they are not generated by NConf. All folders listed here will be included in the output file, together with the generated config.

  • make sure apache has write-access to all these folders & files
  • make sure no binary files are in these folders; trying to edit a binary file will crash your browser!

We recommend you to copy your static files into the 'nconf/static_cfg' folder. If security permits it, you could make your active Nagios configuration editable in NConf directly. We discourage users from doing this though, because there is a risk that they could accidentally damage their Nagios configuration.

Usage: $STATIC_CONFIG = array("static_cfg", "/etc/nagios", "...");
Default value: $STATIC_CONFIG = array("static_cfg");

CHECK_STATIC_SYNTAX

Syntax checking for static config folders.
Static config will be treated as “global” config. Syntax checking will be run for each Collector / Monitor server. In a distributed monitoring setup, you might have to disable syntax checking, if you are getting errors that items don't exist on certain servers.

Possible values: "0", "1"
Default value:   "1"


Special contact groups

$SUPERADMIN_GROUPS

This is an array that can contain the names of multiple contact groups. These groups will be added to every host and service, regardless if they were assigned via the GUI or not. Use this option if you want to make sure that certain groups are linked in any case. Make sure the groups you define actually exist.

Usage: $SUPERADMIN_GROUPS = array("admins", "super-heroes");
Default value: $SUPERADMIN_GROUPS = array("+admins");

$ONCALL_GROUPS

This is another array that can contain the names of multiple contact groups. If you have an on-call organisation, or would generally like to enforce users to assign one or more of these groups to a host or service, list the groups here. Users will not be able to save modifications to hosts or services, if they haven't assigned one or more of the groups listed here. Make sure the groups you define actually exist.

Usage: $ONCALL_GROUPS = array("oncall_unix", "oncall_win");
Default value: $ONCALL_GROUPS = array();


Password attributes

Password attributes are not an official Nagios feature. NConf allows you to specify password attributes, which are used either to generate an Apache htpasswd file (which in turn can be used to control access to Nagios), or to control access to NConf itself via “Auth by SQL”. By default, a hidden attribute named “user_password” is added to each “contact”.

The following configuration options control the behavour of password attributes:

PASSWD_ENC

Defines the password encryption type. Will be used when writing passwords to the database, and is also used for authentication. Used when AUTH_TYPE is:

  • file
  • sql

Make sure the way you've stored your passwords matches the encryption type set here, or authentication will fail.

Possible values: "clear", "crypt", "md5", "sha", "sha_raw"
Default value: "clear"

Use “crypt” if you wish to use passwords for Apache htpasswd based authentication.
Alternatively, you can use “sha_raw” mode if you wish to use SHA1 passwords for Apache htpasswd (normal “sha” mode will not work).

CAUTION: If you change this value, you have to manually update all the password attributes already set, because the old value will remain encrypted with the previous encryption in the database. You won't be able to log in, if the encryption does not match.

more information:
See for more information in the Authentication specific options

CRYPT_SALT

Obsolete as of NConf 1.3

The salt will now be generated automatically.

PASSWD_DISPLAY

Configures the visibility of password attributes.

Possible values: "0", "1"
Default value: "0"
plaintext password attribute


If PASSWD_DISPLAY = 1, you will see passwords plaintext on the detail view.


hidden password attributes


If PASSWD_DISPLAY = 0, the passwords will not be visible (in the detail view).

Since NConf 1.3 password attributes will now be displayed with html password-input fields on add or modify formular.
password input field

PASSWD_HIDDEN_STRING

If PASSWD_DISPLAY = 0 then this value will be used to hide the password.
Any passwords will be represented as the following string (in the detail view):

Default value: "********"


Additional options

OVERVIEW_QUANTITY_STANDARD

Defines the amount of entries shown on the overview page.

Possible values: NUMBER
Default value: "25"

SELECT_VALUE_SEPARATOR

This defines the separator for the values of “select” type attributes.

Possible values: any character(s)
Default value: "::"

There should be no reason to change the default value
If you change this, you must also update all your existing attributes of type “select”. This can be done under “Attributes → Show” → modify all “select” attributes.

nconf/help/documentation/detail/general_configuration.txt · Last modified: 21.02.2013 00:21 by agargiulo