diff --git a/doc/API/ARP.md b/doc/API/ARP.md index c842f4e8b7..1f0c0cb08d 100644 --- a/doc/API/ARP.md +++ b/doc/API/ARP.md @@ -3,7 +3,7 @@ path: blob/master/doc/ ### `list_arp` -Retrieve a specific ARP entry or all ARP enties for a device +Retrieve a specific ARP entry or all ARP entries for a device Route: `/api/v0/resources/ip/arp/:query` diff --git a/doc/API/Devices.md b/doc/API/Devices.md index 131406df93..4a512da91c 100644 --- a/doc/API/Devices.md +++ b/doc/API/Devices.md @@ -105,7 +105,7 @@ Output: ### `availability` -Get calculated availabilites of given device. +Get calculated availabilities of given device. Route: `/api/v0/devices/:hostname/availability` diff --git a/doc/Developing/Creating-Documentation.md b/doc/Developing/Creating-Documentation.md index 401091064e..64d30688b1 100644 --- a/doc/Developing/Creating-Documentation.md +++ b/doc/Developing/Creating-Documentation.md @@ -31,7 +31,7 @@ documentation to go along with it. It's quite simple to do this: - If the document could cover different distros like CentOS and Ubuntu please try and include the information for them all. If that's not possible then at least put a placeholder in asking for contributions. - - Ensure you use the correct formating for `commands` and `code + - Ensure you use the correct formatting for `commands` and `code blocks` by wrapping one liners in backticks or blocks in ```. - Put content into sub-headings where possible to organise the content. diff --git a/doc/Developing/Sensor-State-Support.md b/doc/Developing/Sensor-State-Support.md index c0059a5ede..1c449c0bfa 100644 --- a/doc/Developing/Sensor-State-Support.md +++ b/doc/Developing/Sensor-State-Support.md @@ -117,7 +117,7 @@ modules: For advanced state discovery: This example will be based on a Cisco power supply sensor and is all -it takes to have sensor state support for Cisco power supplys in Cisco +it takes to have sensor state support for Cisco power supplies in Cisco switches. The file should be located in /includes/discovery/sensors/state/cisco.inc.php. ```php diff --git a/doc/Developing/os/Wireless-Sensors.md b/doc/Developing/os/Wireless-Sensors.md index a82588558a..f2b4662673 100644 --- a/doc/Developing/os/Wireless-Sensors.md +++ b/doc/Developing/os/Wireless-Sensors.md @@ -32,7 +32,7 @@ with the values we expect to see the data in: | ssr | dB | WirelessSsrDiscovery | The Signal strength ratio, the ratio(or difference) of Vertical rx power to Horizontal rx power | | utilization | % | WirelessUtilizationDiscovery | The % of utilization compared to the current rate | -You will need to create a new OS class for your os if one doen't exist +You will need to create a new OS class for your os if one doesn't exist under `LibreNMS/OS`. The name of this file should be the os name in camel case for example `airos -> Airos`, `ios-wlc -> IosWlc`. @@ -62,40 +62,40 @@ All discovery interfaces will require you to return an array of WirelessSensor o `new WirelessSensor()` Accepts the following arguments: -- $type = Required. This is the sensor class from the table above (i.e humidity). -- $device_id = Required. You can get this value with $this->getDeviceId() -- $oids = Required. This must be the numerical OID for where the data +- `$type =` Required. This is the sensor class from the table above (i.e humidity). +- `$device_id =` Required. You can get this value with $this->getDeviceId() +- `$oids =` Required. This must be the numerical OID for where the data can be found, i.e .1.2.3.4.5.6.7.0. If this is an array of oids, you should probably specify an $aggregator. -- $subtype = Required. This should be the OS name, i.e airos. -- $index = Required. This must be unique for this sensor type, device and subtype. +- `$subtype =` Required. This should be the OS name, i.e airos. +- `$index =` Required. This must be unique for this sensor type, device and subtype. Typically it's the index from the table being walked or it could be the name of the OID if it's a single value. -- $description = Required. This is a descriptive value for the sensor. +- `$description =` Required. This is a descriptive value for the sensor. Shown to the user, if this is a per-ssid statistic, using `SSID: $ssid` here is appropriate -- $current = Defaults to null. Can be used to set the current value on discovery. +- `$current =` Defaults to null. Can be used to set the current value on discovery. If this is null the values will be polled right away and if they do not return valid value(s), the sensor will not be discovered. Supplying a value here implies you have already verified this sensor is valid. -- $multiplier = Defaults to 1. This is used to multiply the returned value. -- $divisor = Defaults to 1. This is used to divided the returned value. +- `$multiplier =` Defaults to 1. This is used to multiply the returned value. +- `$divisor =` Defaults to 1. This is used to divided the returned value. - $aggregator = Defaults to sum. Valid values: sum, avg. This will combine multiple values from multiple oids into one. -- $access_point_id = Defaults to null. If this is a wireless +- `$access_point_id =` Defaults to null. If this is a wireless controller, you can link sensors to entries in the access_points table. -- $high_limit = Defaults to null. Sets the high limit for the sensor, +- `$high_limit =` Defaults to null. Sets the high limit for the sensor, used in alerting to report out range sensors. -- $low_limit = Defaults to null. Sets the low threshold limit for the +- `$low_limit =` Defaults to null. Sets the low threshold limit for the sensor, used in alerting to report out range sensors. -- $high_warn = Defaults to null. Sets the high warning limit for the +- `$high_warn =` Defaults to null. Sets the high warning limit for the sensor, used in alerting to report near out of range sensors. -- $low_warn = Defaults to null. Sets the low warning limit for the +- `$low_warn =` Defaults to null. Sets the low warning limit for the sensor, used in alerting to report near out of range sensors. -- $entPhysicalIndex = Defaults to null. Sets the entPhysicalIndex to +- `$entPhysicalIndex =` Defaults to null. Sets the entPhysicalIndex to be used to look up further hardware if available. -- $entPhysicalIndexMeasured = Defaults to null. Sets the type of +- `$entPhysicalIndexMeasured =` Defaults to null. Sets the type of entPhysicalIndex used, i.e ports. Polling is done automatically based on the discovered data. If for diff --git a/doc/Extensions/Authentication.md b/doc/Extensions/Authentication.md index fd2361dfba..4f21015314 100644 --- a/doc/Extensions/Authentication.md +++ b/doc/Extensions/Authentication.md @@ -29,7 +29,7 @@ longer be available to log in.** To enable a particular authentication module you need to set this up in config.php. Please note that only ONE module can be -enabled. LibreNMS doesn't support multiple authentication mechanism at +enabled. LibreNMS doesn't support multiple authentication mechanisms at the same time. ```php @@ -111,8 +111,8 @@ Cleanup of old accounts is done by checking the authlog. You will need to set the number of days when old accounts will be purged AUTOMATICALLY by daily.sh. -Please ensure that you set the $config['authlog_purge'] value to be -greater than $config['active_directory']['users_purge'] otherwise old +Please ensure that you set the `$config['authlog_purge']` value to be +greater than `$config['active_directory']['users_purge']` otherwise old users won't be removed. ## Sample configuration @@ -271,8 +271,8 @@ Cleanup of old accounts is done by checking the authlog. You will need to set the number of days when old accounts will be purged AUTOMATICALLY by daily.sh. -Please ensure that you set the $config['authlog_purge'] value to be -greater than $config['radius']['users_purge'] otherwise old users +Please ensure that you set the `$config['authlog_purge']` value to be +greater than `$config['radius']['users_purge']` otherwise old users won't be removed. # HTTP Authentication @@ -391,7 +391,7 @@ This, along with the defaults, sets up a basic Single Sign-on setup that: - Reads values from environment variables - Automatically creates users when they're first seen -- Authomatically updates users with new values +- Automatically updates users with new values - Gives everyone privilege level 10 This happens to mimic the behaviour of [http-auth](#http-auth), so if @@ -521,7 +521,7 @@ This filter causes the mechanism to only consider groups matching a regular expr ### Logout Behaviour LibreNMS has no capability to log out a user authenticated via Single -Sign-On - that responsability falls to the Relying Party. +Sign-On - that responsibility falls to the Relying Party. If your Relying Party has a magic URL that needs to be called to end a session, you can configure LibreNMS to direct the user to it: @@ -530,7 +530,7 @@ session, you can configure LibreNMS to direct the user to it: $config['post_logout_action'] = '/Shibboleth.sso/Logout'; ``` -This option functions independantly of the Single Sign-on mechanism. +This option functions independently of the Single Sign-on mechanism. ## Complete Configuration diff --git a/doc/Extensions/Dashboards.md b/doc/Extensions/Dashboards.md index 8c7d246d9d..b4f4a32f20 100644 --- a/doc/Extensions/Dashboards.md +++ b/doc/Extensions/Dashboards.md @@ -18,8 +18,8 @@ LibreNMS has a whole list of Widgets to select from. - Availability Map: Displays all devices with colored tiles, green up, yellow for warning (device has been restarted in last 24 hours),red for down. You can also list all services and ignored/disabled - devcies in this widget. -- Componet Status: List all componets Ok state, Warning state, Critical state. + devices in this widget. +- Components Status: List all components Ok state, Warning state, Critical state. - Device Summary horizontal: List device totals, up, down, ignored, disabled. Same for ports and services. - Device Summary vertical: List device totals, up, down, ignored, @@ -36,9 +36,9 @@ LibreNMS has a whole list of Widgets to select from. usage. Note the device type has to be listed as "Server". - Syslog: Displays all syslog entries. - Top Devices: By Traffic, or Uptime, or Response time, or Poller - Duration, or Procssor load, or Memory Usage, or Storage Usage. + Duration, or Processor load, or Memory Usage, or Storage Usage. - Top Interfaces: Lists top interfaces by traffic utilization. -- Worldmap: displays all your devices locations. From syslocation or +- World Map: displays all your devices locations. From syslocation or from override sysLocation. List of Widgets: @@ -48,7 +48,7 @@ List of Widgets: ## Dashboard Permissions -- Private: Sets the dashabord to only the user that created the +- Private: Sets the dashboard to only the user that created the dashboard can view and edit. - Shared Read: Sets the dashboard to allow other users to view the dashboard, but cant make changes to the dashboard. @@ -95,7 +95,7 @@ id. You will need to know this in order to map the port to the graph. When using the Generic-image widget you can provide the width and height of the widget with your request. This will ensure that the image will fit nicely with the dimensions if the Generic-image widget. -You can add @AUTO_HEIGHT@ and @AUTO_WIDTH@ to the Image URL as parameters. +You can add `@AUTO_HEIGHT@` and `@AUTO_WIDTH@` to the Image URL as parameters. Examples: diff --git a/doc/Extensions/Dell-OpenManage.md b/doc/Extensions/Dell-OpenManage.md index ee31661755..b76e7baf2e 100644 --- a/doc/Extensions/Dell-OpenManage.md +++ b/doc/Extensions/Dell-OpenManage.md @@ -28,13 +28,13 @@ Ensure that srvadmin is started, this is usually done by executing: ``` Once this has been done, add the device to LibreNMS as normal and you -will start to receive Temperatures and Fanspeed data. +will start to receive Temperatures and Fan speed data. # Windows Download OpenManage from Dell's support page [Link](http://www.dell.com/support/contents/us/en/04/article/product-support/self-support-knowledgebase/enterprise-resource-center/systemsmanagement/OMSA) -and install OpenManage onyour windows server. Make sure you have SNMP +and install OpenManage on your windows server. Make sure you have [SNMP](/Support/SNMP-Configuration-Examples/#windows-server-2012-r2-and-newer) setup and running on your windows server. diff --git a/doc/Extensions/Dispatcher-Service.md b/doc/Extensions/Dispatcher-Service.md index f54ab7212c..65a212d44a 100644 --- a/doc/Extensions/Dispatcher-Service.md +++ b/doc/Extensions/Dispatcher-Service.md @@ -62,7 +62,7 @@ connections and other important health metrics. # Configuration Connection settings are required in `.env`. The `.env` file is -generated after composer install and APP_KEY and NODE_ID are set. +generated after composer install and `APP_KEY` and `NODE_ID` are set. Remember that the APP_KEY value must be the same on all your pollers. ```dotenv diff --git a/doc/Extensions/Graylog.md b/doc/Extensions/Graylog.md index b231240248..305feb1ffc 100644 --- a/doc/Extensions/Graylog.md +++ b/doc/Extensions/Graylog.md @@ -35,9 +35,10 @@ $config['graylog']['password'] = 'admin'; $config['graylog']['version'] = '2.4'; ``` +## Timezone Graylog messages are stored using GMT timezone. You can display graylog messages in LibreNMS webui using your desired timezone by -setting following option in config.php: +setting the following option in config.php: ```php $config['graylog']['timezone'] = 'Europe/Bucharest'; @@ -46,41 +47,78 @@ $config['graylog']['timezone'] = 'Europe/Bucharest'; Timezone must be PHP supported timezones, available at: +## Graylog Version If you are running a version earlier than Graylog then please set -`$config['graylog']['version']` to the version number of your Graylog +```php +$config['graylog']['version'] +``` +to the version number of your Graylog install. Earlier versions than 2.1 use the default port `12900` +## URI If you have altered the default uri for your Graylog setup then you -can override the default of `/api/` using `$config['graylog']['base_uri'] = '/somepath/';` +can override the default of `/api/` using +```php +$config['graylog']['base_uri'] = '/somepath/'; +``` +## User Credentials If you choose to use another user besides the admin user, please note that currently you must give the user "admin" permissions from within Graylog, "read" permissions alone are not sufficient. +## TLS Certificate If you have enabled TLS for the Graylog API and you are using a self-signed certificate, please make sure that the certificate is trusted by your LibreNMS host, otherwise the connection will fail. Additionally, the certificate's Common Name (CN) has to match -the FQDN or IP address specified in `$config['graylog']['server']`. +the FQDN or IP address specified in +```php +$config['graylog']['server'] +``` +## Match Any Address If you want to match the source address of the log entries against any IP address of a device instead of only against the primary address and the host name to assign the log entries to a device, you can activate -this function using $config['graylog']['match-any-address'] = 'true'; +this function using +```php +$config['graylog']['match-any-address'] = 'true'; +``` + +## Recent Devices There are 2 configuration parameters to influence the behaviour of the "Recent Graylog" table on the overview page of the -devices. $config['graylog']['device-page']['rowCount'] sets the -maximum number of rows to be displayed (default: 10) With -$config['graylog']['device-page']['loglevel'] you can set which -loglevels should be displayed on the overview page. (default: 7, min: -0, max: 7) $config['graylog']['device-page']['loglevel'] = 4 shows -only entries with a log level less than or equal to 4 (Emergency, +devices. + +```php +$config['graylog']['device-page']['rowCount'] +``` + +Sets the maximum number of rows to be displayed (default: 10) + + + + +```php +$config['graylog']['device-page']['loglevel'] +``` + +You can set which loglevels that should be displayed on the overview page. (default: 7, min: +0, max: 7) + +```php +$config['graylog']['device-page']['loglevel'] = 4 +``` +Shows only entries with a log level less than or equal to 4 (Emergency, Alert, Critical, Error, Warning). You can set a default Log Level Filter with -$config['graylog']['loglevel'] (applies to /graylog and -/device/device=/tab=logs/section=graylog/ (min: 0, max: 7) +```php +$config['graylog']['loglevel'] +``` + (applies to /graylog and /device/device=/tab=logs/section=graylog/ (min: 0, max: 7) # Suppressing/enabling the domain part of a hostname for specific platforms diff --git a/doc/Extensions/IRC-Bot-Extensions.md b/doc/Extensions/IRC-Bot-Extensions.md index 802d6ff4ae..d091a7c61b 100644 --- a/doc/Extensions/IRC-Bot-Extensions.md +++ b/doc/Extensions/IRC-Bot-Extensions.md @@ -3,7 +3,7 @@ path: blob/master/doc/ # Quick Guide -Okay this is a very quick walk-through in writing own `commands` for the IRC-Bot. +Okay this is a very quick walk-through in writing your own `commands` for the IRC-Bot. First of all, create a file in `includes/ircbot`, the file-name should be in this format: `command.inc.php`. diff --git a/doc/Extensions/Network-Map.md b/doc/Extensions/Network-Map.md index 150b7c8cc5..c580b0939b 100644 --- a/doc/Extensions/Network-Map.md +++ b/doc/Extensions/Network-Map.md @@ -28,7 +28,7 @@ Groups can be drawn with Network Map. This link will show you all the options and explain what they do. [Link](https://visjs.github.io/vis-network/docs/network/) -You may also access the dyanamic configuration interface [example +You may also access the dynamic configuration interface [example here](https://visjs.github.io/vis-network/examples/network/other/configuration.html) from within LibreNMS by adding the following to config.php @@ -43,7 +43,7 @@ $config['network_map_vis_options'] = '{ You may want to disable the automatic page refresh while you're tweaking your configuration, as the refresh will reset the dynamic configuration UI to the values currently saved in config.php This can -be done by going clicking on the Settings Icon then Refresh Pause. +be done by clicking on the Settings Icon then Refresh Pause. ## Configurator Output @@ -51,9 +51,9 @@ Once you've achieved your desired map appearance, click the generate options button at the bottom to be given the necessary parameters to add to your config.php file. You will need to paste the genrated config into config.php the format will need to look something like -this. Note that the configuartor will output the config with `var options` -you will need strip that out and at the end of the config you need to -add in `}';` see the example below. +this. Note that the configurator will output the config with `var options` +you will need to strip them out and at the end of the config you need to +add an `}';` see the example below. ```php $config['network_map_vis_options'] = '{ diff --git a/doc/Extensions/Oxidized.md b/doc/Extensions/Oxidized.md index a41ac85a28..7d558fd1bd 100644 --- a/doc/Extensions/Oxidized.md +++ b/doc/Extensions/Oxidized.md @@ -64,7 +64,7 @@ $config['oxidized']['default_group'] = 'default'; # SELinux -If you're runnng SELinux, you'll need to allow httpd to connect +If you're running SELinux, you'll need to allow httpd to connect outbound to the network, otherwise Oxidized integration in the web UI will silently fail: diff --git a/doc/Extensions/RRDCached.md b/doc/Extensions/RRDCached.md index 2ad25c3dcb..a21b97f97d 100644 --- a/doc/Extensions/RRDCached.md +++ b/doc/Extensions/RRDCached.md @@ -15,7 +15,7 @@ $config['rrdtool_version'] = '1.5.5'; This setting has to be the exact version of rrdtool you are running. NOTE: This feature requires your client version of rrdtool to be 1.5.5 -or over, in addition to your rrdcached version. +or newer, in addition to your rrdcached version. # Distributed Poller Support Matrix diff --git a/doc/Extensions/Rancid.md b/doc/Extensions/Rancid.md index 60931b5f75..20e5d27935 100644 --- a/doc/Extensions/Rancid.md +++ b/doc/Extensions/Rancid.md @@ -112,7 +112,7 @@ Test config: `sudo /usr/lib/rancid/bin/clogin -f /var/lib/rancid/.cloginrc ` NOTE: IF you run into a 'diffie-hellmen' kind of error, then it is -because your Linux distro is using newer encyryprtion methods +because your Linux distro is using newer encryption methods etc. This is basically just letting you know that the device you tested on is running an outdated encryption type. I recommend updating downstream device if able. If not, the following should fix: diff --git a/doc/Extensions/SNMP-Trap-Handler.md b/doc/Extensions/SNMP-Trap-Handler.md index c7759e307f..d825ca90c1 100644 --- a/doc/Extensions/SNMP-Trap-Handler.md +++ b/doc/Extensions/SNMP-Trap-Handler.md @@ -4,7 +4,7 @@ path: blob/master/doc/ # SNMP trap handling Currently, LibreNMS supports a lot of trap handlers. You can check them on -GitHub [there](https://github.com/librenms/librenms/tree/master/LibreNMS/Snmptrap/Handlers). +GitHub [here](https://github.com/librenms/librenms/tree/master/LibreNMS/Snmptrap/Handlers). To add more see [Adding new SNMP Trap handlers](../Developing/SNMP-Traps.md). Traps are handled via snmptrapd. snmptrapd is an SNMP application that receives and logs SNMP TRAP and INFORM messages. @@ -77,7 +77,7 @@ WantedBy=multi-user.target ``` > In Ubuntu 18 is service located by default in ```/etc/systemd/system/multi-user.target.wants/snmptrapd.service``` -There is a list of snmptrapd options: +Here is a list of snmptrapd options: | Option | Description | | -------| ------------------------------------------------------------------------------------------------ | @@ -94,21 +94,21 @@ as well as BGP traps, use `-m IF-MIB:BGP4-MIB`. Multiple files can be added, sep If you want to test or store original TRAPS in log then: -Create folder for storing traps for example in file `traps.log` +Create a folder for storing traps for example in file `traps.log` ``` sudo mkdir /var/log/snmptrap ``` -Add following config to your snmptrapd.service after `ExecStart=/usr/sbin/snmptrapd -f -m ALL -M /opt/librenms/mibs` +Add the following config to your snmptrapd.service after `ExecStart=/usr/sbin/snmptrapd -f -m ALL -M /opt/librenms/mibs` ``` -tLf /var/log/snmptrap/traps.log ``` -After succesfuly configured service reload service files, enable, and start the snmptrapd service: +After successfully configuring the service, reload service files, enable, and start the snmptrapd service: ``` sudo systemctl daemon-reload @@ -160,7 +160,7 @@ So what value should you type in the commands below? Oddly enough, simply supply You can configure generic event logging for snmp traps. This will log an event of the type trap for received traps. These events can be used for alerting. -By default, only the TrapOID is logged. Buf you can enable the "detailed" variant, +By default, only the TrapOID is logged. But you can enable the "detailed" variant, and all the data received with the trap will be logged. The parameter can be found in General Settings / External / SNMP Traps Integration. diff --git a/doc/Extensions/Services.md b/doc/Extensions/Services.md index 3d83ef6cd7..fc3429a633 100644 --- a/doc/Extensions/Services.md +++ b/doc/Extensions/Services.md @@ -6,10 +6,10 @@ path: blob/master/doc/ Services within LibreNMS provides the ability to leverage Nagios plugins to perform additional monitoring outside of SNMP. Services can also be used -in conjuction with your SNMP monitoring for larger monitoring functionality. +in conjunction with your SNMP monitoring for larger monitoring functionality. **Services must be tied to a device to function properly. A good generic -option is to use `localhost`, but it is suggest to attach the check to +option is to use `localhost`, but it is suggested to attach the check to the device you are monitoring.** ## Nagios plugins source diff --git a/doc/Extensions/Smokeping.md b/doc/Extensions/Smokeping.md index 1e7a9a2569..bd66e4d882 100644 --- a/doc/Extensions/Smokeping.md +++ b/doc/Extensions/Smokeping.md @@ -66,7 +66,7 @@ remark = Welcome to the SmokePing website of Insert Company Name Here. \ Note there may be other stanza's (possibly `*** Slaves ***`) between the `*** Probes ***` and `*** Targets ***` stanza's - leave these intact. -Leave everything else untouched. If you need to add other confiruation, make +Leave everything else untouched. If you need to add other configuration, make sure it comes *after* the LibreNMS configuration, and keep in mind that Smokeping does not allow duplicate modules, and cares about the configuration file sequence. @@ -120,7 +120,7 @@ remark = Welcome to the SmokePing website of Insert Company Name Here. \ @include /etc/smokeping/config.d/librenms-targets.conf ``` -Leave everything else untouched. If you need to add other confiruation, make +Leave everything else untouched. If you need to add other configuration, make sure it comes *after* the LibreNMS configuration, and keep in mind that Smokeping does not allow duplicate modules, and cares about the configuration file sequence. @@ -229,7 +229,7 @@ is OK with `sudo nginx -t`, then restart Nginx with `sudo systemctl restart ngin You should be able to load the Smokeping web interface at `http://yourhost/smokeping` -#### Nginx Password Authentification +#### Nginx Password Authentication You can use the purpose-made htpasswd utility included in the apache2-utils package (Nginx password files use the same format as @@ -321,8 +321,8 @@ definitions. ### File '/usr/sbin/sendmail' does not exist` -If you got this error at the end of the installation, simply edit -commend out the sendmail entry in the configuration: +If you got this error at the end of the installation, simply edit or +comment out the sendmail entry in the configuration: ```diff -sendmail = /usr/sbin/sendmail diff --git a/doc/Extensions/Varnish.md b/doc/Extensions/Varnish.md index 03cccfc56c..1c59d28427 100644 --- a/doc/Extensions/Varnish.md +++ b/doc/Extensions/Varnish.md @@ -14,7 +14,7 @@ decrease page load times significantly. # Simplified block diagram of an Apache HTTP server with Varnish 4.0 Reverse Proxy -![Block Diagram 1](@= config.site_url =@/img/varnish_block.png) +![Block Diagram 1](/img/varnish_block.png) # CentOS 7 Varnish Installation diff --git a/doc/Extensions/Weathermap.md b/doc/Extensions/Weathermap.md index 909e953f2e..b9056187df 100644 --- a/doc/Extensions/Weathermap.md +++ b/doc/Extensions/Weathermap.md @@ -5,7 +5,7 @@ path: blob/master/doc/ Integrating LibreNMS with Network-Weathermap, allows you to build network maps to help visulaize network traffic flow rates. -[Link](https://network-weathermap.com/) to Network-Wearthermap Offical +[Link](https://network-weathermap.com/) to Network-Wearthermap Official Website ## Prerequisites diff --git a/doc/Extensions/World-Map.md b/doc/Extensions/World-Map.md index ef467c34a0..26ce721b13 100644 --- a/doc/Extensions/World-Map.md +++ b/doc/Extensions/World-Map.md @@ -24,11 +24,15 @@ Location resolution happens as follows Example: +``` [40.424521, -86.912755] +``` or +``` 1100 Congress Ave, Austin, TX 78701 +``` We have two current mapping engines available: diff --git a/doc/Installation/Images.md b/doc/Installation/Images.md index 006ad63e7b..1cc95e5b6d 100644 --- a/doc/Installation/Images.md +++ b/doc/Installation/Images.md @@ -16,7 +16,7 @@ At present we provide the following builds: - OVA Built with VirtualBox. - Any issues and or help with these images should be reported via - [Community Fourm](https://community.librenms.org) or our [Discord + [Community Forum](https://community.librenms.org) or our [Discord server](https://t.libren.ms/discord) ## Setup diff --git a/doc/Installation/Installation-CentOS-6-Apache-Nginx.md b/doc/Installation/Installation-CentOS-6-Apache-Nginx.md index 0f37ddec23..7044bd3a5f 100644 --- a/doc/Installation/Installation-CentOS-6-Apache-Nginx.md +++ b/doc/Installation/Installation-CentOS-6-Apache-Nginx.md @@ -36,7 +36,7 @@ chkconfig mariadb on service mariadb start ``` -## Gneral +## General Now continue with the installation: @@ -283,7 +283,7 @@ chown -R librenms:librenms /opt/librenms chmod 775 rrd ``` -If you're planing on running rrdcached, make sure that the path is +If you're planning on running rrdcached, make sure that the path is also chmod'ed to 775 and chown'ed to librenms:librenms. **SELinux** diff --git a/doc/Support/Adding-a-Device.md b/doc/Support/Adding-a-Device.md index 1739e03d55..453865418a 100644 --- a/doc/Support/Adding-a-Device.md +++ b/doc/Support/Adding-a-Device.md @@ -36,8 +36,8 @@ community `my_company` using snmp `v2c` then you would enter: SNMP Port defaults to 161. By default Hostname will be used for polling data. If you want -to get polling Device data via a specific IP-Addresse (e.g. Management IP) -fill out the optional field `Overwrite IP` with it's IP-Addresse. +to get polling Device data via a specific IP-Address (e.g. Management IP) +fill out the optional field `Overwrite IP` with it's IP-Address. ![Add device](/img/webui_add_device.png) @@ -59,5 +59,5 @@ If you would like to add devices automatically then you will probably want to read the [Auto-discovery Setup](../Extensions/Auto-Discovery.md) guide. -You may also want to add devices programatically, if so, take a look +You may also want to add devices programmatically, if so, take a look at our [API documentation](../API/index.md) diff --git a/doc/Support/Device-Troubleshooting.md b/doc/Support/Device-Troubleshooting.md index ba1c5f8ddb..721c504855 100644 --- a/doc/Support/Device-Troubleshooting.md +++ b/doc/Support/Device-Troubleshooting.md @@ -14,7 +14,7 @@ far right and selecting Capture. ## Discovery -Discovery will run and output debug infomation. +Discovery will run and output debug information. ## Poller diff --git a/doc/Support/FAQ.md b/doc/Support/FAQ.md index f200a06b5a..6eaf457c2e 100644 --- a/doc/Support/FAQ.md +++ b/doc/Support/FAQ.md @@ -183,7 +183,7 @@ ifIn/OutOctets value and record that. Now, it appears as though all of the traffic since it stopped getting values have occurred in the last 5 minute interval. -So whenever you see spikes like this, it means we have not received data from the device for several polling intervals. The cause can vary quite a bit: bad snmp implementations, intermittant network connectivity, broken poller, and more. +So whenever you see spikes like this, it means we have not received data from the device for several polling intervals. The cause can vary quite a bit: bad snmp implementations, intermittent network connectivity, broken poller, and more. ## Why do I see gaps in my graphs? @@ -197,7 +197,7 @@ Modules Performance. Take a look at what modules are taking the longest and disabled un used modules. If you poll a large number of devices / ports then it's recommended to -run a local recurisve dns server such as pdns-recursor. +run a local recursive dns server such as pdns-recursor. Running RRDCached is also highly advised in larger installs but has benefits no matter the size. @@ -267,7 +267,7 @@ do so by setting `$config['uptime_warning'] = '84600';` in ## Why do I not see all interfaces in the Overall traffic graph for a device? By default numerous interface types and interface descriptions are -excluded from this graph. The excluded defailts are: +excluded from this graph. The excluded defaults are: ```php $config['device_traffic_iftype'][] = '/loopback/'; @@ -440,7 +440,7 @@ LibreNMS improve. own time. - Documentation. Documentation can always be improved and every little bit helps. Not all features are currently documented or documented - well, there's speeling mistakes etc. It's very easy to submit + well, there's spelling mistakes etc. It's very easy to submit updates [through the GitHub website](https://help.github.com/articles/editing-files-in-another-user-s-repository/), no git experience needed. @@ -582,7 +582,7 @@ To view a prediction: You should now see a linear prediction line on the graph. ## How do I move only the DB to another server? -There is already a reference how to move your whole LNMS installation to another server. But the following steps will help you to split up an "All-in-one" installation to one LibreNMS installation with a seperate database install. +There is already a reference how to move your whole LNMS installation to another server. But the following steps will help you to split up an "All-in-one" installation to one LibreNMS installation with a separate database install. *Note: This section assumes you have a MySQL/MariaDB instance - Stop the apache and mysql service in you LibreNMS installation. diff --git a/doc/Support/Features.md b/doc/Support/Features.md index adcc908bef..471850c3e1 100644 --- a/doc/Support/Features.md +++ b/doc/Support/Features.md @@ -8,7 +8,7 @@ If you think something is missing, feel free to ask us. * Auto discovery * Alerting -* Multiple environnement sensors support +* Multiple environment sensors support * Multiple protocols data collection (STP, OSPF, BGP etc) * VLAN, ARP and FDB table collection * Customizable Dashboards diff --git a/doc/Support/Performance.md b/doc/Support/Performance.md index 30c07cb3f3..e21bb6e86c 100644 --- a/doc/Support/Performance.md +++ b/doc/Support/Performance.md @@ -150,7 +150,7 @@ Running `./scripts/collect-port-polling.php` will poll your devices with both full and selective polling, display a table with the difference and optionally enable or disable selected ports polling for devices which would benefit from a change. Note that it doesn't -continously re-evaluate this, it will only be updated when the script +continuously re-evaluate this, it will only be updated when the script is run. There are a number of options: ``` @@ -181,7 +181,7 @@ A lot of performance can be gained from setting up `php-opcache` correctly. **Note: Memory based caching with PHP cli will increase memory usage and slow things down. File based caching is not as fast as memory based and is more likely to have stale cache issues.** -Some distributions allow seperate cli, mod_php and php-fpm configurations, we can use this to set the optimal config. +Some distributions allow separate cli, mod_php and php-fpm configurations, we can use this to set the optimal config. ### For web servers using mod_php and php-fpm diff --git a/doc/Support/SNMP-Configuration-Examples.md b/doc/Support/SNMP-Configuration-Examples.md index 854fd7ce86..51e4a064b4 100644 --- a/doc/Support/SNMP-Configuration-Examples.md +++ b/doc/Support/SNMP-Configuration-Examples.md @@ -30,7 +30,7 @@ Table of Content: - [Linux (snmpd v2)](#linux-snmpd) - [Linux (snmpd v3)](#linux-snmpd-v3) - [Windows Server 2008 R2](#windows-server-2008-r2) - - [Windows Server 2012 R2 and 2016](#windows-server-2012-r2-and-2016) + - [Windows Server 2012 R2 and newer](#windows-server-2012-r2-and-newer) - [Mac OSX](#Mac-OSX) ## Devices @@ -120,7 +120,7 @@ snmp-server location #### Network Card-MS 1. Connect to the Web UI of the device -1. Upgrade to the lastest available manufacturer firmware which applies to your hardware revision. Refer to the releasenotes. For devices which can use the Lx releases, *do* install LD. +1. Upgrade to the latest available manufacturer firmware which applies to your hardware revision. Refer to the release notes. For devices which can use the Lx releases, *do* install LD. 1. After rebooting the card (safe for connected load), configure Network, System and Access Control. Save config for each step. 1. Configure SNMP. The device defaults to both SNMP v1 and v3 enabled, with default credentials. Disable what you do not need. SNMP v3 works, but uses MD5/DES. You may have to add another section to your SNMP credentials table in LibreNMS. Save. @@ -314,7 +314,7 @@ esxcli system snmp set -C noc@your.org esxcli system snmp set --enable true ``` ->Note: In case of snmp timouts, disable the firewall with `esxcli +>Note: In case of snmp timeouts, disable the firewall with `esxcli >network firewall set --enabled false` If snmp timeouts still occur >with firewall disabled, migrate VMs if needed and reboot ESXi host. @@ -479,9 +479,10 @@ service snmpd restart LibreNMS server IP address 1. Validate change by clicking "Apply" -### Windows Server 2012 R2 and 2016 +### Windows Server 2012 R2 and newer -1. Log in to your Windows Server 2012 R2 +#### GUI +1. Log in to your Windows Server 2012 R2 or newer 1. Start "Server Manager" under "Administrative Tools" 1. Click "Manage" and then "Add Roles and Features" 1. Continue by pressing "Next" to the "Features" menu @@ -494,6 +495,17 @@ service snmpd restart LibreNMS server IP address 1. Validate change by clicking "Apply" +#### PowerShell +The following example will install SNMP, set the Librenms IP and set a read only community string. +Replace `$IP` and `$communitystring` with your values. + +```Powershell +Install-WindowsFeature -Name 'SNMP-Service','RSAT-SNMP' +New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\services\SNMP\Parameters\PermittedManagers" -Name 2 -Value $IP +New-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\services\SNMP\Parameters\ValidCommunities" -Name $communitystring -Value 4 + +``` + >Note: SNMPv3 can be supported on Windows platforms with the use of Net-SNMP. ### Mac OSX