mirror/librenms-librenms
1
0
Fork 0
mirror of https://github.com/librenms/librenms.git synced 2024-10-07 16:52:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more md linting (#10371)

Browse Source 
* clean 1-Minute-Polling.md formatting

* cleanup formatting for Adding-a-Device.md

* clean up formatting of Cleanup-options.md

* cleanup formatting some for CLI-Tools.md

* cleanup formatting for Syslog.md and Configuration.md

* cleanup formatting for Device-Sensors.md

* cleanup formatting for Device-Troubleshooting.md

* cleanup Discovery Support.md

* cleanup Environment-Variables.md

* cleanup Example-Hardware-Setup.md and FAQ.mg

* update Features.md, Install Validation.md, Perfermance.md, Poller Support.md, and index.md

* cleanup Remote-Monitoring-VPN.md, SNMP-Configuration-Examples.md, and SSL-Configuration.md

* lots of updates for Installation docs

* more installation doc cleanup

* more formatting cleanup

* clean Work-Map.md up some
This commit is contained in:
VVelox
2019-07-18 21:25:53 -05:00
committed by Tony Murray
parent cfdd23d2c2
commit 06b85f5b07
45 changed files with 3650 additions and 1801 deletions
Download Patch File Download Diff File Expand all files Collapse all files

394
doc/Support/Configuration.md
View File

@@ -4,24 +4,29 @@ The options shown below also contain the default values.
If you would like to alter any of these then please add your config option to `config.php`.
### Directories
# Directories
```php
$config['install_dir'] = "/opt/librenms";
```
Set the installation directory (defaults to /opt/librenms), if you clone the GitHub branch to another location ensure you alter this.
Set the installation directory (defaults to /opt/librenms), if you
clone the GitHub branch to another location ensure you alter this.
```php
$config['temp_dir'] = "/tmp";
```
The temporary directory is where images and other temporary files are created on your filesystem.
The temporary directory is where images and other temporary files are
created on your filesystem.
```php
$config['log_dir'] = "/opt/librenms/logs";
```
Log files created by LibreNMS will be stored within this directory.
### Database config
# Database config
These are the configuration options you will need to use to specify to get started.
@@ -34,38 +39,44 @@ $config['db_name'] = '';
```
If you use a unix socket, you can specify it with these options:
```php
$config['db_host'] = NULL;
$config['db_port'] = NULL;
$config['db_socket'] = '/run/mysqld/mysqld.sock';
```
### Core
# Core
#### PHP Settings
## PHP Settings
You can change the memory limits for php within `config.php`. The value is in Megabytes and should just be an int value:
You can change the memory limits for php within `config.php`. The
value is in Megabytes and should just be an int value:
`$config['php_memory_limit'] = 128;`
### Programs
## Programs
A lot of these are self explanatory so no further information may be provided. Any extensions that have dedicated
documentation page will be linked to rather than having the config provided.
A lot of these are self explanatory so no further information may be
provided. Any extensions that have dedicated documentation page will
be linked to rather than having the config provided.
#### RRDTool
> You can configure these options within the WebUI now, please avoid setting these options within config.php
### RRDTool
> You can configure these options within the WebUI now, please avoid
> setting these options within config.php
>
> Settings -> External Settings -> RRDTool Setup
```php
$config['rrdtool'] = "/usr/bin/rrdtool";
```
Please see [1 Minute polling](1-Minute-Polling.md) for information on configuring your install to record data more frequently.
Please see [1 Minute polling](1-Minute-Polling.md) for information on
configuring your install to record data more frequently.
### fping
#### fping
```php
$config['fping'] = "/usr/bin/fping";
$config['fping6'] = "fping6";
@@ -73,13 +84,19 @@ $config['fping_options']['timeout'] = 500;
$config['fping_options']['count'] = 3;
$config['fping_options']['interval'] = 500;
```
`fping` configuration options:
* `timeout` (`fping` parameter `-t`): Amount of time that fping waits for a response to its first request (in milliseconds). **See note below**
* `count` (`fping` parameter `-c`): Number of request packets to send to each target.
* `interval` (`fping` parameter `-p`): Time in milliseconds that fping waits between successive packets to an individual target.
* `timeout` (`fping` parameter `-t`): Amount of time that fping waits
for a response to its first request (in milliseconds). **See note
below**
* `count` (`fping` parameter `-c`): Number of request packets to send
to each target.
* `interval` (`fping` parameter `-p`): Time in milliseconds that fping
waits between successive packets to an individual target.
> NOTE: Setting a higher timeout value than the interval value can lead to slowing down poller. Example:
> NOTE: Setting a higher timeout value than the interval value can
> lead to slowing down poller. Example:
>
> timeout: 3000
>
@@ -87,35 +104,46 @@ $config['fping_options']['interval'] = 500;
>
> interval: 500
>
> In this example, interval will be overwritten by the timeout value of 3000 which is 3 seconds. As we send three icmp packets (count: 3), each one is delayed by 3 seconds which will result in fping taking > 6 seconds to return results.
> In this example, interval will be overwritten by the timeout value
> of 3000 which is 3 seconds. As we send three icmp packets (count:
> 3), each one is delayed by 3 seconds which will result in fping
> taking > 6 seconds to return results.
You can disable the fping / icmp check that is done for a device to be determined to be up on a global or per device basis.
**We don't advise disabling the fping / icmp check unless you know the impact, at worst if you have a large number of devices down
then it's possible that the poller would no longer complete in 5 minutes due to waiting for snmp to timeout.**
You can disable the fping / icmp check that is done for a device to be
determined to be up on a global or per device basis. **We don't advise
disabling the fping / icmp check unless you know the impact, at worst
if you have a large number of devices down then it's possible that the
poller would no longer complete in 5 minutes due to waiting for snmp
to timeout.**
Globally disable fping / icmp check:
```php
$config['icmp_check'] = false;
```
If you would like to do this on a per device basis then you can do so under Device -> Edit -> Misc -> Disable ICMP Test? On
If you would like to do this on a per device basis then you can do so
under Device -> Edit -> Misc -> Disable ICMP Test? On
#### traceroute
LibreNMS uses traceroute / traceroute6 to record debug information when a device is down due to icmp AND you have `$config['debug']['run_trace'] = true;`
set.
### traceroute
LibreNMS uses traceroute / traceroute6 to record debug information
when a device is down due to icmp AND you have
`$config['debug']['run_trace'] = true;` set.
```php
$config['traceroute'] = '/usr/bin/traceroute';
$config['traceroute6'] = '/usr/bin/traceroute6';
```
#### SNMP
### SNMP
```php
$config['snmpwalk'] = "/usr/bin/snmpwalk";
$config['snmpget'] = "/usr/bin/snmpget";
$config['snmpbulkwalk'] = "/usr/bin/snmpbulkwalk";
```
SNMP program locations.
```php
@@ -131,7 +159,8 @@ $config['unflatten'] = "/usr/bin/unflatten";
$config['neato'] = "/usr/bin/neato";
$config['sfdp'] = "/usr/bin/sfdp";
```
### Authentication
# Authentication
Generic Authentication settings.
@@ -139,10 +168,10 @@ Generic Authentication settings.
$config['password']['min_length'] = 8; // password minimum length for auth that allows user creation
```
### Proxy support
# Proxy support
For alerting and the callback functionality, we support the use of a http proxy setting.
These can be any one of the following:
For alerting and the callback functionality, we support the use of a
http proxy setting. These can be any one of the following:
```php
$config['callback_proxy'] = 'proxy.domain.com';
@@ -156,38 +185,48 @@ http_proxy=proxy.domain.com
https_proxy=proxy.domain.com
```
### RRDCached
# RRDCached
[RRDCached](../Extensions/RRDCached.md)
### WebUI Settings
# WebUI Settings
```php
$config['base_url'] = "http://demo.librenms.org";
```
LibreNMS will attempt to detect the URL you are using but you can override that here.
```php
$config['site_style'] = "light";
```
Currently we have a number of styles which can be set which will alter the navigation bar look. dark, light and mono with light being the default.
Currently we have a number of styles which can be set which will alter
the navigation bar look. dark, light and mono with light being the default.
```php
$config['webui']['custom_css'][] = "css/custom/styles.css";
```
You can override a large number of visual elements by creating your own css stylesheet and referencing it here, place any custom css files into
`html/css/custom` so they will be ignored by auto updates. You can specify as many css files as you like, the order they are within your config
will be the order they are loaded in the browser.
You can override a large number of visual elements by creating your
own css stylesheet and referencing it here, place any custom css files
into `html/css/custom` so they will be ignored by auto updates. You
can specify as many css files as you like, the order they are within
your config will be the order they are loaded in the browser.
```php
$config['title_image'] = "images/custom/yourlogo.png";
```
You can override the default logo with yours, place any custom images files into `html/images/custom` so they will be ignored by auto updates.
You can override the default logo with yours, place any custom images
files into `html/images/custom` so they will be ignored by auto updates.
```php
$config['page_refresh'] = "300";
```
Set how often pages are refreshed in seconds. The default is every 5 minutes. Some pages don't refresh at all by design.
Set how often pages are refreshed in seconds. The default is every 5
minutes. Some pages don't refresh at all by design.
```php
$config['front_page'] = "pages/front/default.php";
@@ -198,13 +237,17 @@ $config['vertical_summary'] = 0; // Enable to use vertical summary on front page
$config['top_ports'] = 1; // This enables the top X ports box
$config['top_devices'] = 1; // This enables the top X devices box
```
A number of home pages are provided within the install and can be found in html/pages/front/. You can change the default by
setting `front_page`. The other options are used to alter the look of those pages that support it (default.php supports these options).
A number of home pages are provided within the install and can be
found in html/pages/front/. You can change the default by setting
`front_page`. The other options are used to alter the look of those
pages that support it (default.php supports these options).
```php
// This option exists in the web UI, edit it under Global Settings -> webui
$config['webui']['default_dashboard_id'] = 0;
```
Allows the specification of a global default dashboard page for any user who
has not set one in their user preferences. Should be set to dashboard_id of an
existing dashboard that is shared or shared(read). Otherwise, the system will
@@ -214,11 +257,13 @@ first login.
```php
$config['login_message'] = "Unauthorised access or use shall render the user liable to criminal and/or civil prosecution.";
```
This is the default message on the login page displayed to users.
```php
$config['public_status'] = false;
```
If this is set to true then an overview will be shown on the login page of devices and the status.
```php
@@ -237,11 +282,14 @@ $config['int_peering'] = 1; # Enable Peering Types
$config['int_core'] = 1; # Enable Core Port Types
$config['int_l2tp'] = 0; # Enable L2TP Port Types
```
Enable / disable certain menus from being shown in the WebUI.
You are able to adjust the number and time frames of the quick select time options for graphs and the mini graphs shown per row.
You are able to adjust the number and time frames of the quick select
time options for graphs and the mini graphs shown per row.
Quick select:
```php
$config['graphs']['mini']['normal'] = array(
'day' => '24 Hours',
@@ -263,6 +311,7 @@ $config['graphs']['mini']['widescreen'] = array(
```
Mini graphs:
```php
$config['graphs']['row']['normal'] = array(
'sixhour' => '6 Hours',
@@ -280,48 +329,67 @@ $config['graphs']['row']['normal'] = array(
```php
$config['web_mouseover'] = true;
```
You can disable the mouseover popover for mini graphs by setting this to false.
```php
$config['enable_lazy_load'] = true;
```
You can disable image lazy loading by setting this to false.
```php
$config['show_overview_tab'] = true;
```
Enable or disable the overview tab for a device.
```php
$config['overview_show_sysDescr'] = true;
```
Enable or disable the sysDescr output for a device.
```php
$config['force_ip_to_sysname'] = false;
```
When using IP addresses as a hostname you can instead represent the devices on the WebUI by its SNMP sysName resulting in an easier to read overview of your network. This would apply on networks where you don't have DNS records for most of your devices.
When using IP addresses as a hostname you can instead represent the
devices on the WebUI by its SNMP sysName resulting in an easier to
read overview of your network. This would apply on networks where you
don't have DNS records for most of your devices.
```php
$config['force_hostname_to_sysname'] = false;
```
When using a dynamic DNS hostname or one that does not resolve, this option would allow you to make use of the SNMP sysName instead as the preferred reference to the device.
When using a dynamic DNS hostname or one that does not resolve, this
option would allow you to make use of the SNMP sysName instead as the
preferred reference to the device.
```php
$config['device_traffic_iftype'][] = '/loopback/';
```
Interface types that aren't graphed in the WebUI. The default array contains more items, please see includes/defaults.inc.php for the full list.
Interface types that aren't graphed in the WebUI. The default array
contains more items, please see includes/defaults.inc.php for the full list.
```php
$config['enable_clear_discovery'] = 1;
```
Administrators are able to clear the last discovered time of a device which will force a full discovery run within the configured 5 minute cron window.
Administrators are able to clear the last discovered time of a device
which will force a full discovery run within the configured 5 minute cron window.
```php
$config['enable_footer'] = 1;
```
Disable the footer of the WebUI by setting `enable_footer` to 0.
You can enable the old style network map (only available for individual devices with links discovered via xDP) by setting:
You can enable the old style network map (only available for
individual devices with links discovered via xDP) by setting:
```php
$config['gui']['network-map']['style'] = 'old';
```
@@ -329,50 +397,66 @@ $config['gui']['network-map']['style'] = 'old';
```php
$config['percentile_value'] = X;
```
Show the `X`th percentile in the graph instead of the default 95th percentile.
```php
$config['shorthost_target_length'] = X;
```
The target maximum hostname length when applying the shorthost() function.
You can increase this if you want to try and fit more of the hostname in graph titles.
The default value is 12
However, this can possibly break graph generation if this is very long.
The default value is 12 However, this can possibly break graph
generation if this is very long.
You can enable dynamic graphs within the WebUI under Global Settings -> Webui Settings -> Graph Settings.
You can enable dynamic graphs within the WebUI under Global Settings
-> Webui Settings -> Graph Settings.
Graphs will be movable/scalable without reloading the page:
![Example dynamic graph usage](img/dynamic-graph-usage.gif)
### Stacked Graphs
You can enable stacked graphs instead of the default inverted graphs.
Enabling them is possible via webui Global Settings -> Webui Settings -> Graph settings -> Use stacked graphs
## Stacked Graphs
You can enable stacked graphs instead of the default inverted
graphs. Enabling them is possible via webui Global Settings -> Webui
Settings -> Graph settings -> Use stacked graphs
## Add host settings
The following setting controls how hosts are added. If a host is
added as an ip address it is checked to ensure the ip is not already
present. If the ip is present the host is not added. If host is added
by hostname this check is not performed. If the setting is true
hostnames are resolved and the check is also performed. This helps
prevents accidental duplicate hosts.
### Add host settings
The following setting controls how hosts are added. If a host is added as an ip address it is checked to ensure the ip is not already present. If the ip is present the host is not added.
If host is added by hostname this check is not performed. If the setting is true hostnames are resolved and the check is also performed. This helps prevents accidental duplicate hosts.
```php
$config['addhost_alwayscheckip'] = false; #true - check for duplicate ips even when adding host by name.
#false- only check when adding host by ip.
```
By default we allow hosts to be added with duplicate sysName's, you can disable this with the following config:
By default we allow hosts to be added with duplicate sysName's, you
can disable this with the following config:
```php
$config['allow_duplicate_sysName'] = false;
```
### Global poller and discovery modules
Generally, it is a better to set these [per OS](../Developing/os/Settings.md#poller-and-discovery-modules) or device.
# Global poller and discovery modules
Generally, it is a better to set these [per
OS](../Developing/os/Settings.md#poller-and-discovery-modules) or
device.
```php
$config['discovery_modules]['arp-table'] = true;
$config['poller_modules']['bgp-peers'] = false;
```
### SNMP Settings
# SNMP Settings
Default SNMP options including retry and timeout settings and also default version and port.
Default SNMP options including retry and timeout settings and also
default version and port.
```php
$config['snmp']['timeout'] = 1; # timeout in seconds
@@ -382,15 +466,19 @@ $config['snmp']['version'] = ['v2c', 'v3', 'v1']; # Default versions t
$config['snmp']['port'] = 161; # Default port
$config['snmp']['exec_timeout'] = 1200; # execution time limit in seconds
```
>NOTE: `timeout` is the time to wait for an answer and `exec_timeout` is the max time to run a query.
The default v1/v2c snmp community to use, you can expand this array with `[1]`, `[2]`, `[3]`, etc.
>NOTE: `timeout` is the time to wait for an answer and `exec_timeout`
>is the max time to run a query.
The default v1/v2c snmp community to use, you can expand this array
with `[1]`, `[2]`, `[3]`, etc.
```php
$config['snmp']['community'][0] = "public";
```
The default v3 snmp details to use, you can expand this array with `[1]`, `[2]`, `[3]`, etc.
The default v3 snmp details to use, you can expand this array with
`[1]`, `[2]`, `[3]`, etc.
```php
$config['snmp']['v3'][0]['authlevel'] = "noAuthNoPriv"; # noAuthNoPriv | authNoPriv | authPriv
@@ -401,13 +489,14 @@ $config['snmp']['v3'][0]['cryptopass'] = ""; # Privacy (Encryption)
$config['snmp']['v3'][0]['cryptoalgo'] = "AES"; # AES | DES
```
### Auto discovery settings
# Auto discovery settings
[Auto-Discovery](../Extensions/Auto-Discovery.md)
### Email configuration
# Email configuration
> You can configure these options within the WebUI now, please avoid setting these options within config.php
> You can configure these options within the WebUI now, please avoid
> setting these options within config.php
```php
$config['email_backend'] = 'mail';
@@ -422,18 +511,20 @@ $config['email_smtp_auth'] = false;
$config['email_smtp_username'] = NULL;
$config['email_smtp_password'] = NULL;
```
What type of mail transport to use for delivering emails. Valid options for `email_backend` are mail, sendmail or smtp.
The varying options after that are to support the different transports.
### Alerting
What type of mail transport to use for delivering emails. Valid
options for `email_backend` are mail, sendmail or smtp. The varying
options after that are to support the different transports.
# Alerting
[Alerting](../Alerting/index.md)
### Billing
# Billing
[Billing](../Extensions/Billing-Module.md)
### Global module support
# Global module support
```php
$config['enable_bgp'] = 1; # Enable BGP session collection and display
@@ -444,7 +535,7 @@ $config['enable_vrfs'] = 1; # Enable VRFs
$config['enable_sla'] = 0; # Enable Cisco SLA collection and display
```
### Port extensions
# Port extensions
[Port-Description-Parser](../Extensions/Port-Description-Parser.md)
@@ -454,29 +545,36 @@ $config['enable_ports_junoseatmvp'] = 0;
$config['enable_ports_adsl'] = 1;
$config['enable_ports_poe'] = 0;
```
Enable / disable additional port statistics.
### External integration
# External integration
#### Rancid
## Rancid
```php
$config['rancid_configs'][] = '/var/lib/rancid/network/configs/';
$config['rancid_repo_type'] = 'svn';
$config['rancid_ignorecomments'] = 0;
```
Rancid configuration, `rancid_configs` is an array containing all of the locations of your rancid files.
Setting `rancid_ignorecomments` will disable showing lines that start with #
#### Oxidized
Rancid configuration, `rancid_configs` is an array containing all of
the locations of your rancid files. Setting `rancid_ignorecomments`
will disable showing lines that start with #
## Oxidized
[Oxidized](../Extensions/Oxidized.md)
#### CollectD
## CollectD
```php
$config['collectd_dir'] = '/var/lib/collectd/rrd';
```
Specify the location of the collectd rrd files. Note that the location in config.php should be consistent with the location set in /etc/collectd.conf and etc/collectd.d/rrdtool.conf
Specify the location of the collectd rrd files. Note that the location
in config.php should be consistent with the location set in
/etc/collectd.conf and etc/collectd.d/rrdtool.conf
```php
<Plugin rrdtool>
@@ -487,6 +585,7 @@ Specify the location of the collectd rrd files. Note that the location in config
WritesPerSecond 50
</Plugin>
```
/etc/collectd.conf
```php
@@ -497,42 +596,58 @@ LoadPlugin rrdtool
CacheFlush 900
</Plugin>
```
/etc/collectd.d/rrdtool.conf
```php
$config['collectd_sock'] = 'unix:///var/run/collectd.sock';
```
Specify the location of the collectd unix socket. Using a socket allows the collectd graphs to be flushed to disk before being drawn. Be sure that your web server has permissions to write to this socket.
#### Smokeping
Specify the location of the collectd unix socket. Using a socket
allows the collectd graphs to be flushed to disk before being
drawn. Be sure that your web server has permissions to write to this socket.
## Smokeping
[Smokeping](../Extensions/Smokeping.md)
#### NFSen
## NFSen
[NFSen](../Extensions/NFSen.md)
### Location mapping
## Location mapping
If you just want to set GPS coordinates on a location, you should visit Devices > Geo Locations > All Locations and edit the coordinates there.
If you just want to set GPS coordinates on a location, you should
visit Devices > Geo Locations > All Locations and edit the coordinates
there.
Exact Matching:
```php
$config['location_map']['Under the Sink'] = "Under The Sink, The Office, London, UK";
```
Regex Matching:
```php
$config['location_map_regex']['/Sink/'] = "Under The Sink, The Office, London, UK";
```
Regex Match Substitution:
```php
$config['location_map_regex_sub']['/Sink/'] = "Under The Sink, The Office, London, UK [lat, long]";
```
If you have an SNMP SysLocation of "Rack10,Rm-314,Sink", Regex Match Substition yields "Rack10,Rm-314,Under The Sink, The Office, London, UK [lat, long]". This allows you to keep the SysLocation string short and keeps Rack/Room/Building information intact after the substitution.
The above are examples, these will rewrite device snmp locations so you don't need to configure full location within snmp.
If you have an SNMP SysLocation of "Rack10,Rm-314,Sink", Regex Match
Substition yields "Rack10,Rm-314,Under The Sink, The Office, London,
UK [lat, long]". This allows you to keep the SysLocation string short
and keeps Rack/Room/Building information intact after the substitution.
### Interfaces to be ignored
The above are examples, these will rewrite device snmp locations so
you don't need to configure full location within snmp.
# Interfaces to be ignored
Examples:
@@ -541,7 +656,9 @@ $config['bad_if'][] = "voip-null";
$config['bad_iftype'][] = "voiceEncap";
$config['bad_if_regexp'][] = '/^lo[0-9].*/'; // loopback
```
Numerous defaults exist for this array already (see includes/defaults.inc.php for the full list). You can expand this list
Numerous defaults exist for this array already (see
includes/defaults.inc.php for the full list). You can expand this list
by continuing the array.
`bad_if` is matched against the ifDescr value.
@@ -554,7 +671,7 @@ by continuing the array.
`bad_ifalias_regexp` is matched against the ifAlias value as a regular expression.
### Interfaces that shouldn't be ignored
# Interfaces that shouldn't be ignored
Examples:
@@ -563,44 +680,51 @@ $config['good_if'][] = 'FastEthernet';
$config['os']['ios']['good_if'][] = 'FastEthernet';
```
`good_if` is matched against ifDescr value. This can be a bad_if value as well which would stop that port from being ignored.
I.e If bad_if and good_if both contained FastEthernet then ports with this value in the ifDescr will be valid.
`good_if` is matched against ifDescr value. This can be a bad_if value
as well which would stop that port from being ignored. I.e If bad_if
and good_if both contained FastEthernet then ports with this value in
the ifDescr will be valid.
### Interfaces to be rewritten
# Interfaces to be rewritten
```php
$config['rewrite_if']['cpu'] = 'Management Interface';
$config['rewrite_if_regexp']['/cpu /'] = 'Management ';
```
Entries defined in `rewrite_if` are being replaced completely.
Entries defined in `rewrite_if_regexp` only replace the match.
Matches are compared case-insensitive.
### Entity sensors to be ignored
# Entity sensors to be ignored
Some devices register bogus sensors as they are returned via SNMP but either don't exist or just don't return data.
This allows you to ignore those based on the descr field in the database. You can either ignore globally or on a per
os basis.
Some devices register bogus sensors as they are returned via SNMP but
either don't exist or just don't return data. This allows you to
ignore those based on the descr field in the database. You can either
ignore globally or on a per os basis.
```php
$config['bad_entity_sensor_regex'][] = '/Physical id [0-9]+/';
$config['os']['cisco']['bad_entity_sensor_regex'] = '/Physical id [0-9]+/';
```
### Entity sensors limit values
# Entity sensors limit values
Vendors may give some limit values (or thresholds) for the discovered sensors. By default, when no such value is given,
both high and low limit values are guessed, based on the value measured during the initial discovery.
Vendors may give some limit values (or thresholds) for the discovered
sensors. By default, when no such value is given, both high and low
limit values are guessed, based on the value measured during the initial discovery.
When it is preferred to have no high and/or low limit values at all if
these are not provided by the vendor, the guess method can be disabled:
When it is preferred to have no high and/or low limit values at all if these are not provided by the vendor, the guess
method can be disabled:
```php
$config['sensors']['guess_limits'] = false;
```
### Storage configuration
# Storage configuration
Mounted storage / mount points to ignore in discovery and polling.
```php
$config['ignore_mount_removable'] = 1;
$config['ignore_mount_network'] = 1;
@@ -630,20 +754,21 @@ $config['ignore_mount_regexp'][] = "/UMA/";
```
Custom storage warning percentage
```php
$config['storage_perc_warn'] = 60;
$config['os']['linux']['storage_perc_warn'] = 60;
```
### IRC Bot
# IRC Bot
[IRC Bot](../Extensions/IRC-Bot.md)
### Authentication
# Authentication
[Authentication](../Extensions/Authentication.md)
### Cleanup options
# Cleanup options
These options rely on daily.sh running from cron as per the installation instructions.
@@ -657,51 +782,58 @@ $config['alert_log_purge'] = 365;
$config['port_fdb_purge'] = 10;
$config['rrd_purge'] = 90;// Not set by default
```
These options will ensure data within LibreNMS over X days old is automatically purged. You can alter these individually.
values are in days.
> NOTE: Please be aware that `$config['rrd_purge']` is _NOT_ set by default. This option will remove any old data within
the rrd directory automatically - only enable this if you are comfortable with that happening.
These options will ensure data within LibreNMS over X days old is
automatically purged. You can alter these individually. values are in days.
### Syslog options
> NOTE: Please be aware that `$config['rrd_purge']` is _NOT_ set by
> default. This option will remove any old data within the rrd
> directory automatically - only enable this if you are comfortable
> with that happening.
# Syslog options
[Syslog](../Extensions/Syslog.md)
### Virtualization
# Virtualization
```php
$config['enable_libvirt'] = 1;
$config['libvirt_protocols'] = array("qemu+ssh","xen+ssh");
$config['libvirt_username'] = 'root';
```
Enable this to switch on support for libvirt along with `libvirt_protocols`
to indicate how you connect to libvirt. You also need to:
1. Generate a non-password-protected ssh key for use by LibreNMS, as the
1. Generate a non-password-protected ssh key for use by LibreNMS, as the
user which runs polling & discovery (usually `librenms`).
2. On each VM host you wish to monitor:
- Configure public key authentication from your LibreNMS server/poller by
adding the librenms public key to `~root/.ssh/authorized_keys`.
- (xen+ssh only) Enable libvirtd to gather data from xend by setting
`(xend-unix-server yes)` in `/etc/xen/xend-config.sxp` and
restarting xend and libvirtd.
1. On each VM host you wish to monitor:
1. Configure public key authentication from your LibreNMS server/poller by
adding the librenms public key to `~root/.ssh/authorized_keys`.
1. (xen+ssh only) Enable libvirtd to gather data from xend by setting
`(xend-unix-server yes)` in `/etc/xen/xend-config.sxp` and
restarting xend and libvirtd.
To test your setup, run `virsh -c qemu+ssh://vmhost/system list` or
`virsh -c xen+ssh://vmhost list` as your librenms polling user.
### BGP Support
# BGP Support
```php
$config['astext']['65332'] = "Cymru FullBogon Feed";
```
You can use this array to rewrite the description of ASes that you have discovered.
### Auto updates
# Auto updates
[Updating](../General/Updating.md)
### IPMI
Setup the types of IPMI protocols to test a host for and in what order. Don't forget to install ipmitool on the monitoring host.
# IPMI
Setup the types of IPMI protocols to test a host for and in what
order. Don't forget to install ipmitool on the monitoring host.
```php
$config['ipmi']['type'] = array();
@@ -711,19 +843,19 @@ $config['ipmi']['type'][] = "imb";
$config['ipmi']['type'][] = "open";
```
### Distributed poller settings
# Distributed poller settings
[Distributed Poller](../Extensions/Distributed-Poller.md)
## API Settings
# API Settings
### CORS Support
# CORS Support
https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS
<https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS>
CORS support for the API is disabled by default. Below you will find
the standard options, all of which you can configure.
CORS support for the API is disabled by default. Below you will find the standard options,
all of which you can configure.
```php
$config['api']['cors']['enabled'] = false;
$config['api']['cors']['origin'] = '*';