noc.conf file stores global configuration shared between daemons
[main] section
Name | Type | Description | Values | Example |
---|---|---|---|---|
debug | Boolean | Whether to display error reports in the HTML page (For non-AJAX applications only) |
| |
debug_js | Boolean | Load non-minified versions of js libraries, if not false |
| |
server_email | String | From: field for all server-generated emails | noc@example.com | |
admin_email | String | Comma-separated list of emails which will receive error_reports when debug option set to false | ||
timezone | String | cal time zone for installation. Choices can be found here: PostgreSQL DATETIME-TIMEZONE although not all variations may be possible on all operating systems. | Europe/Moscow | |
language_code | String | Language code for installation. All choices can be found here: w3.org | en | |
secret_key | String | Random string used as seed for web session protection. Make this key unique and keep secret. | DSFJsbkbwjkhzsdhuE42s | |
date_format | String | Default date format to be used by NOC. See Datetime Format for format characters description | ||
time_format | String | Default time format to be used by NOC. See Datetime Format for format characters description | ||
month_day_format | String | Default month and day format to be used by NOC. See Datetime Format for format characters description | ||
year_month_format | String | Default year and month format to be used by NOC. See Datetime Format for format characters description | ||
datetime_format | String | Default date and time format to be used by NOC. See Datetime Format for format characters description | ||
polling_method | String | Socket factory polling method. |
| |
installed_apps | String | Comma-separated list of locally installed django applicatons | noc.myapp1,noc.myapp2 | |
crashinfo_limit | Integer | Maximal size of crash info file. Larger crash dumps will be silently discarded | 1000000 | |
log_api_calls | Boolean | Enable REST API calls logging |
| false |
log_sql_statements | Boolean | Enable logging SQL statements |
| false |
[database] section
PostgreSQL database credentials
Name | Type | Description | Values | Example |
---|---|---|---|---|
engine | String | Database engine. Only postgresql_psycopg2 supported at this moment. | postgresql_psycopg2 | |
name | String | Database name | noc | |
user | String | Database user | noc | |
password | String | Database password, if required | secret | |
host | String | Database host or UNIX socket path |
| |
port | Integer | Database port, if not default |
[nosql] section
mongodb database credentials and settings
Name | Type | Description | Values | Example |
---|---|---|---|---|
name | String | mongodb database name | noc | |
user | String | mongod database user | noc | |
password | String | mongodb database password, if required | secret | |
host | String | Database host, if not default | ||
port | Integer | Database port, if not default |
[authentication] section
User authentication settings (Additional python-ldap library is required when using ldap authentication method)
Name | Type | Description | Values | Example |
---|---|---|---|---|
method | String | Authentication method |
| local |
restrict_to_group | String | When set, permit logins only to users from specified group | Group name | Admins |
single_session_group | String | When set, permit only one login session per each user of group | Group name | Operators |
mutual_exclusive_group | String | When set, permit only on login session per all users of group | Group name | Mutual |
Parameters applicable for ldap method only | ||||
ldap_server | String | An URL of LDAP server. If your LDAP server requires to directly specify partitions (Like and Apache DS), place partition DN into path | ldap://ldap.example.com/o=partition | |
ldap_bind_method | String | LDAP bind method |
| |
ldap_bind_dn | String | Technical DN to lookup user information. Bind as anonymous user if not set | ||
ldap_bind_password | String | Password for technical user. See ldap_bind_dn for details. Leave empty for anonymous bind. | ||
ldap_users_base | String | Base DN to search for users | ||
ldap_users_filter | String | LDAP Filter expression to find the user. {{username}} string will be substituted with properly quoted username | ||
ldap_groups_base | String | Base DN to search for groups | ||
ldap_required_group | String | Group DN. If set, disable user if not in the group. | ||
ldap_required_filter | String | LDAP Filter expression to check the user. {{user_dn}} string will be substituted with user’s DN | ||
ldap_superuser_group | String | Group DN. If set, grant superuser permissions if user in the group. | ||
ldap_superuser_filter | String | LDAP Filter expression to check the user. {{user_dn}} string will be substituted with user’s DN | ||
Parameters applicable for ad method only | ||||
ad_server | String | An URL of AD server | ||
ad_bind_method | String | AD bind method |
| |
ad_bind_dn | String | Technical DN to lookup user information. Bind as anonymous user if not set | ||
ad_bind_password | String | Password for technical user. See ad_bind_dn for details. Leave empty for anonymous bind. | ||
ad_users_base | String | Base DN to search for users | ||
ad_users_filter | String | LDAP Filter expression to find the user. {{username}} string will be substituted with properly quoted username | ||
ad_groups_base | String | Base DN to search for groups | ||
ad_required_group | String | Group DN. If set, disable user if not in the group. | ||
ad_required_filter | String | LDAP Filter expression to check the user. {{user_dn}} string will be substituted with user’s DN | ||
ad_superuser_group | String | Group DN. If set, grant superuser permissions if user in the group. | ||
ad_superuser_filter | String | LDAP Filter expression to check the user. {{user_dn}} string will be substituted with user’s DN |
[customization] section
Name | Type | Description |
---|---|---|
installation_name | String | The name of the NOC installation. Installation name shown at the top-left corner of the web interface. |
logo_url | String | Absolute or relative url of the logo. Logo is an image shown at the top-left corner of the web interface |
logo_height | Integer | A height of the logo in pixels |
logo_width | Integer | A width of the logo in pixels |
favicon_url | String | An url for page icon |
default_theme | String | Default UI theme. See [themes] section for the list of available themes |
[themes] section
Name | Type | Description | Example |
---|---|---|---|
<theme>.name | String | Theme's name | gray.name = Gray |
<theme>.css | String | Theme's CSS URL | gray.css = /static/resources/css/ext-all-gray.css |
<theme>.enabled | Boolean | Theme's status (enabled/disabled) | gray.enabled = true |
[path] section
Name | Type | Description |
---|---|---|
backup_dir | String | Directory to place database and repo backup. Must be writable by noc user. Ensure backup_dir is readable and writable only by trusted users |
ssh | String | A path to the ssh binary |
tar | String | A path to the tar binary. POSIX-compatible tar required. Additional extensions (like z flag) are not necessary |
gzip | String | A path to the gzip binary |
rsync | String | A path to the rsync binary |
dig | String | A path to the dig binary |
pg_dump | String | A path to the PostgreSQL pg_dump utility. Ensure proper version of pg_dump used (PostgreSQL 8.1 or later) |
mongodump | String | A path to the MongoDB’s mongodump utility. |
smilint | String | A path to the smilint utility. smilint is a part of libsmi distribution |
smidump | String | A path to the smidump utility. smidump is a part of libsmi distribution |
gpg | String | A path to GnuPG binary. |
[cm] section
This section describes configuration management settings
Name | Type | Description | Values |
---|---|---|---|
repo | String | Path to the repository. repo must be writable by noc user. Ensure backup_dir is readable and writable only by trusted users | |
vcs_type | String | A type of Version Control System (VCS) used by cm. |
|
concurrency | Integer | When non-zero, limit amount of concurrently pulled configs to avoid activators overload | |
timeout_variation | Integer | Random variation of timeout. Variation is necessary to perform local task reordering to prevent constant queue blocking by improperly functioning managed objects. Variation is defined in percents. When timeout is T seconds and variation is V percents real timeout will be calculated as equally distributed random value in interval [T*(1-V/100),T*(1+V/100)] | |
timeout_error | Integer | Timeout to wait when error occurred during get_config script execution | |
timeout_overload | Integer | Timeout to wait when activator reports overload during get_config script execution. Activator overload means activator’s amount of concurrently executing scripts exceeds max_scripts value | |
timeout_down | Integer | Timeout to wait when activator reports target host is down. Target host reachability status updated every time ping probe executed |
[peer] section
Name | Type | Description |
---|---|---|
rpsl_inverse_pref_style | Boolean | Select RPSL pref= behavior. off means pref = localpref, on means standard RPSL’s pref = 65535-localpref |
prefix_list_optimization | Integer | Enable prefix-list optimization whenever possible |
prefix_list_optimization_threshold | Integer | Do not optimize prefix lists shorter than threshold |
max_prefix_length | Integer | Maximal prefix length for generated prefix lists |
use_ripe | Boolean | Use RIPE database to build prefix lists (Can be used together with use_arin and use_radb) |
use_arin | Boolean | Use ARIN database to build prefix lists (Can be used together with use_ripe and use_radb) |
use_radb | Boolean | Use RADb database to build prefix lists (Can be used together with use_ripe and use_arin) |
[dns] section
Name | Type | Description |
---|---|---|
warn_before_expired_days | Integer | Start to issue domain expiration warnings from warn_before_expired_days day before deadline |
[tt] section
Trouble-ticketing system integration.
Name | Type | Description | ||||
---|---|---|---|---|---|---|
url | String | Pattern to convert trouble ticket id to the link URL. Following strings are expanded to:
|
[backup] section
[backup] section contains settings for main.backup periodic task
Name | Type | Description |
---|---|---|
keep_days | Integer | Keep last keep_days days of backups |
keep_weeks | Integer | After keep_days store only one backup per week for the next keep_weeks weeks. Only backups created at keep_day_of_week day of week are left. |
keep_day_of_week | Integer | Keep only backup performed at keep_day_of_week (0 - Monday, 6 - Saturday) |
keep_months | Integer | After keep_weeks interval expired keep only one backup per month for the next keep_months months. Only backups created atkeep_day_of_months days of months are left. |
keep_day_of_month | Integer | Keep only backups performed at keep_day_of_month (1-based) |
[pgp] section
Name | Type | Description |
---|---|---|
use_key | String | Private key used to encrypt message. Must me email or key id. |
keyserver | String | Keyserver used to retrieve missed keys |
[cache] section
Name | Type | Description |
---|---|---|
sa_managedobjectselector_object_ids | Integer | |
vc_vcinterfacescount | Integer | VC module caches |
vc_vcprefixes | Integer |