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

Update Applications.md (#13183)

Browse Source 
fix numbering in application docs
This commit is contained in:
Simon Smith
2021-08-29 16:19:22 +01:00
committed by GitHub
parent 71cd81269a
commit 272713f95d
1 changed files with 27 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
doc/Extensions/Applications.md
View File

@@ -154,33 +154,28 @@ module before trying the script.
1. Download the script onto the desired host (the host must be added 1. Download the script onto the desired host (the host must be added
to LibreNMS devices) to LibreNMS devices)
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/apache-stats.py -O /etc/snmp/apache-stats.py wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/apache-stats.py -O /etc/snmp/apache-stats.py
``` ```
2. Make the script executable 2. Make the script executable
``` ```
chmod +x /etc/snmp/apache-stats.py chmod +x /etc/snmp/apache-stats.py
``` ```
3. Create the cache directory, '/var/cache/librenms/' and make sure 3. Create the cache directory, '/var/cache/librenms/' and make sure
that it is owned by the user running the SNMP daemon. that it is owned by the user running the SNMP daemon.
``` ```
mkdir -p /var/cache/librenms/ mkdir -p /var/cache/librenms/
``` ```
4. Verify it is working by running /etc/snmp/apache-stats.py Package `urllib3` for python3 needs to be 4. Verify it is working by running /etc/snmp/apache-stats.py Package `urllib3` for python3 needs to be
installed. In Debian-based systems for example you can achieve this by issuing: installed. In Debian-based systems for example you can achieve this by issuing:
``` ```
apt-get install python3-urllib3 apt-get install python3-urllib3
``` ```
5. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 5. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend apache /etc/snmp/apache-stats.py extend apache /etc/snmp/apache-stats.py
``` ```
@@ -188,7 +183,6 @@ extend apache /etc/snmp/apache-stats.py
6. Restart snmpd on your host 6. Restart snmpd on your host
7. Test by running 7. Test by running
``` ```
snmpwalk <various options depending on your setup> localhost NET-SNMP-EXTEND-MIB::nsExtendOutput2Table snmpwalk <various options depending on your setup> localhost NET-SNMP-EXTEND-MIB::nsExtendOutput2Table
``` ```
@@ -204,7 +198,6 @@ to be installed: apt-get install libwww-perl)
2. Create the cache directory, '/var/cache/librenms/' and make sure 2. Create the cache directory, '/var/cache/librenms/' and make sure
that it is owned by the user running the SNMP daemon. that it is owned by the user running the SNMP daemon.
``` ```
mkdir -p /var/cache/librenms/ mkdir -p /var/cache/librenms/
``` ```
@@ -226,7 +219,6 @@ wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/aster
``` ```
2. Make the script executable 2. Make the script executable
``` ```
chmod +x /etc/snmp/asterisk chmod +x /etc/snmp/asterisk
``` ```
@@ -236,7 +228,6 @@ chmod +x /etc/snmp/asterisk
4. Verify it is working by running `/etc/snmp/asterisk` 4. Verify it is working by running `/etc/snmp/asterisk`
5. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 5. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend asterisk /etc/snmp/asterisk extend asterisk /etc/snmp/asterisk
``` ```
@@ -265,7 +256,6 @@ chmod +x /etc/snmp/backupninja.py
``` ```
3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend backupninja /etc/snmp/backupninja.py extend backupninja /etc/snmp/backupninja.py
``` ```
@@ -276,16 +266,13 @@ extend backupninja /etc/snmp/backupninja.py
## BIND9 aka named ## BIND9 aka named
1. Create stats file with appropriate permissions: 1. Create stats file with appropriate permissions:
```bash ```bash
~$ touch /var/cache/bind/stats ~$ touch /var/cache/bind/stats
~$ chown bind:bind /var/cache/bind/stats ~$ chown bind:bind /var/cache/bind/stats
``` ```
Change `user:group` to the user and group that's running bind/named. Change `user:group` to the user and group that's running bind/named.
2. Bind/named configuration: 2. Bind/named configuration:
```text ```text
options { options {
... ...
@@ -305,9 +292,7 @@ make sure you changed the ownership correctly.
is called. Given this it is suggested you setup file rotation for is called. Given this it is suggested you setup file rotation for
it. Alternatively you can also set zero_stats to 1 in the config. it. Alternatively you can also set zero_stats to 1 in the config.
6. The script for this also requires the Perl module 6. The script for this also requires the Perl module `File::ReadBackwards`.
`File::ReadBackwards`.
``` ```
FreeBSD => p5-File-ReadBackwards FreeBSD => p5-File-ReadBackwards
CentOS/RedHat => perl-File-ReadBackwards CentOS/RedHat => perl-File-ReadBackwards
@@ -348,19 +333,16 @@ and it will print out what it thinks it should be.
### SNMP Extend ### SNMP Extend
1. Copy the bind shell script, to the desired host. 1. Copy the bind shell script, to the desired host.
``` ```
wget https://github.com/librenms/librenms-agent/raw/master/snmp/bind -O /etc/snmp/bind wget https://github.com/librenms/librenms-agent/raw/master/snmp/bind -O /etc/snmp/bind
``` ```
2. Make the script executable 2. Make the script executable
``` ```
chmod +x /etc/snmp/bind chmod +x /etc/snmp/bind
``` ```
3. Edit your snmpd.conf file and add: 3. Edit your snmpd.conf file and add:
``` ```
extend bind /etc/snmp/bind extend bind /etc/snmp/bind
``` ```
@@ -431,7 +413,6 @@ C.H.I.P. is a $9 R8 based tiny computer ideal for small projects.
Further details: <https://getchip.com/pages/chip> Further details: <https://getchip.com/pages/chip>
1. Copy the shell script to the desired host. 1. Copy the shell script to the desired host.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/chip.sh -O /etc/snmp/power-stat.sh wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/chip.sh -O /etc/snmp/power-stat.sh
``` ```
@@ -442,7 +423,6 @@ chmod +x /etc/snmp/power-stat.sh
``` ```
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend power-stat /etc/snmp/power-stat.sh extend power-stat /etc/snmp/power-stat.sh
``` ```
@@ -463,7 +443,6 @@ Under Ubuntu/Debian just run `apt install dhcpd-pools`
### SNMP Extend ### SNMP Extend
1. Copy the shell script to the desired host. 1. Copy the shell script to the desired host.
``` ```
wget https://github.com/librenms/librenms-agent/raw/master/snmp/dhcp.py -O /etc/snmp/dhcp.py wget https://github.com/librenms/librenms-agent/raw/master/snmp/dhcp.py -O /etc/snmp/dhcp.py
``` ```
@@ -473,17 +452,13 @@ wget https://github.com/librenms/librenms-agent/raw/master/snmp/dhcp.py -O /etc/
chmod +x /etc/snmp/dhcp.py chmod +x /etc/snmp/dhcp.py
``` ```
3. edit a config file: 3. Edit your config file, Content of an example /etc/snmp/dhcp.json
Content of an example /etc/snmp/dhcp.json . Please edit with your own settings.
``` ```
{"leasefile": "/var/lib/dhcp/dhcpd.leases" {"leasefile": "/var/lib/dhcp/dhcpd.leases" }
}
``` ```
Key 'leasefile' specifies the path to your lease file. Key 'leasefile' specifies the path to your lease file.
4. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 4. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend dhcpstats /etc/snmp/dhcp.py extend dhcpstats /etc/snmp/dhcp.py
``` ```
@@ -534,7 +509,6 @@ A small shell script that checks your system's available random entropy.
### SNMP Extend ### SNMP Extend
1. Download the script onto the desired host. 1. Download the script onto the desired host.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/entropy.sh -O /etc/snmp/entropy.sh wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/entropy.sh -O /etc/snmp/entropy.sh
``` ```
@@ -545,7 +519,6 @@ chmod +x /etc/snmp/entropy.sh
``` ```
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend entropy /etc/snmp/entropy.sh extend entropy /etc/snmp/entropy.sh
``` ```
@@ -563,7 +536,6 @@ SNMP extend script to get your exim stats data into your host.
### SNMP Extend ### SNMP Extend
1. Download the script onto the desired host. 1. Download the script onto the desired host.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/exim-stats.sh -O /etc/snmp/exim-stats.sh wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/exim-stats.sh -O /etc/snmp/exim-stats.sh
``` ```
@@ -574,14 +546,12 @@ chmod +x /etc/snmp/exim-stats.sh
``` ```
3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend exim-stats /etc/snmp/exim-stats.sh extend exim-stats /etc/snmp/exim-stats.sh
``` ```
4. If you are using sudo edit your sudo users (usually `visudo`) and 4. If you are using sudo edit your sudo users (usually `visudo`) and
add at the bottom: add at the bottom:
``` ```
snmp ALL=(ALL) NOPASSWD: /etc/snmp/exim-stats.sh, /usr/bin/exim* snmp ALL=(ALL) NOPASSWD: /etc/snmp/exim-stats.sh, /usr/bin/exim*
``` ```
@@ -597,7 +567,6 @@ Extend` heading top of page.
### SNMP Extend ### SNMP Extend
1. Copy the shell script, fail2ban, to the desired host. 1. Copy the shell script, fail2ban, to the desired host.
``` ```
wget https://github.com/librenms/librenms-agent/raw/master/snmp/fail2ban -O /etc/snmp/fail2ban wget https://github.com/librenms/librenms-agent/raw/master/snmp/fail2ban -O /etc/snmp/fail2ban
``` ```
@@ -608,38 +577,30 @@ chmod +x /etc/snmp/fail2ban
``` ```
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend fail2ban /etc/snmp/fail2ban extend fail2ban /etc/snmp/fail2ban
``` ```
If you want to use the cache, it is as below, by using the -c switch. 1. If you want to use the cache, it is as below, by using the -c switch.
``` ```
extend fail2ban /etc/snmp/fail2ban -c extend fail2ban /etc/snmp/fail2ban -c
``` ```
If you want to use the cache and update it if needed, this can by 2. If you want to use the cache and update it if needed, this can by using the -c and -U switches.
using the -c and -U switches.
``` ```
extend fail2ban /etc/snmp/fail2ban -c -U extend fail2ban /etc/snmp/fail2ban -c -U
``` ```
If you need to specify a custom location for the fail2ban-client, that 3. If you need to specify a custom location for the fail2ban-client, that can be done via the -f switch.
can be done via the -f switch.
If not specified, "/usr/bin/env fail2ban-client" is used.
``` ```
extend fail2ban /etc/snmp/fail2ban -f /foo/bin/fail2ban-client extend fail2ban /etc/snmp/fail2ban -f /foo/bin/fail2ban-client
``` ```
If not specified, "/usr/bin/env fail2ban-client" is used.
4. Restart snmpd on your host 1. Restart snmpd on your host
5. If you wish to use caching, add the following to /etc/crontab and 2. If you wish to use caching, add the following to /etc/crontab and
restart cron. restart cron.
``` ```
*/3 * * * * root /etc/snmp/fail2ban -u */3 * * * * root /etc/snmp/fail2ban -u
``` ```
@@ -724,7 +685,6 @@ or /etc/freeradius).
4. Restart FreeRADIUS. 4. Restart FreeRADIUS.
5. You should be able to test with the radclient as follows... 5. You should be able to test with the radclient as follows...
``` ```
echo "Message-Authenticator = 0x00, FreeRADIUS-Statistics-Type = 31, Response-Packet-Type = Access-Accept" | \ echo "Message-Authenticator = 0x00, FreeRADIUS-Statistics-Type = 31, Response-Packet-Type = Access-Accept" | \
radclient -x localhost:18121 status adminsecret radclient -x localhost:18121 status adminsecret
@@ -821,7 +781,6 @@ authentication.
4. Verify it is working by running `/etc/snmp/freeswitch` 4. Verify it is working by running `/etc/snmp/freeswitch`
5. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 5. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend freeswitch /etc/snmp/freeswitch extend freeswitch /etc/snmp/freeswitch
``` ```
@@ -847,7 +806,6 @@ chmod +x /etc/snmp/gpsd
``` ```
3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend gpsd /etc/snmp/gpsd extend gpsd /etc/snmp/gpsd
``` ```
@@ -885,7 +843,6 @@ chmod +x /etc/snmp/icecast-stats.sh
3. Verify it is working by running `/etc/snmp/icecast-stats.sh` 3. Verify it is working by running `/etc/snmp/icecast-stats.sh`
4. Edit your snmpd.conf file (usually `/etc/snmp/icecast-stats.sh`) and add: 4. Edit your snmpd.conf file (usually `/etc/snmp/icecast-stats.sh`) and add:
``` ```
extend icecast /etc/snmp/icecast-stats.sh extend icecast /etc/snmp/icecast-stats.sh
``` ```
@@ -894,7 +851,6 @@ extend icecast /etc/snmp/icecast-stats.sh
### SNMP Extend ### SNMP Extend
1. Download the script into the desired host. 1. Download the script into the desired host.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/mailcow-dockerized-postfix -O /etc/snmp/mailcow-dockerized-postfix wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/mailcow-dockerized-postfix -O /etc/snmp/mailcow-dockerized-postfix
``` ```
@@ -903,11 +859,9 @@ wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/mailc
``` ```
chmod +x /etc/snmp/mailcow-dockerized-postfix chmod +x /etc/snmp/mailcow-dockerized-postfix
``` ```
> Maybe you will need to install `pflogsumm` on debian based OS. Please check if you have package installed. > Maybe you will need to install `pflogsumm` on debian based OS. Please check if you have package installed.
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend mailcow-postfix /etc/snmp/mailcow-dockerized-postfix extend mailcow-postfix /etc/snmp/mailcow-dockerized-postfix
``` ```
@@ -933,7 +887,6 @@ chmod +x /etc/snmp/mailscanner.php
``` ```
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend mailscanner /etc/snmp/mailscanner.php extend mailscanner /etc/snmp/mailscanner.php
``` ```
@@ -951,7 +904,6 @@ This shell script checks mdadm health and array data
### SNMP Extend ### SNMP Extend
1. Download the script onto the desired host. 1. Download the script onto the desired host.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/mdadm -O /etc/snmp/mdadm wget https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/mdadm -O /etc/snmp/mdadm
``` ```
@@ -962,7 +914,6 @@ chmod +x /etc/snmp/mdadm
``` ```
3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add: 3. Edit your snmpd.conf file (usually /etc/snmp/snmpd.conf) and add:
``` ```
extend mdadm /etc/snmp/mdadm extend mdadm /etc/snmp/mdadm
``` ```
@@ -980,7 +931,6 @@ under `SNMP Extend` heading top of page.
1. Copy the [memcached 1. Copy the [memcached
script](https://github.com/librenms/librenms-agent/blob/master/agent-local/memcached) script](https://github.com/librenms/librenms-agent/blob/master/agent-local/memcached)
to `/etc/snmp/` on your remote server. to `/etc/snmp/` on your remote server.
``` ```
wget https://raw.githubusercontent.com/librenms/librenms-agent/master/agent-local/memcached -O /etc/snmp/memcached wget https://raw.githubusercontent.com/librenms/librenms-agent/master/agent-local/memcached -O /etc/snmp/memcached
``` ```
@@ -991,7 +941,6 @@ chmod +x /etc/snmp/memcached
``` ```
3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add: 3. Edit your snmpd.conf file (usually `/etc/snmp/snmpd.conf`) and add:
``` ```
extend memcached /etc/snmp/memcached extend memcached /etc/snmp/memcached
``` ```
@@ -1045,7 +994,6 @@ echo -n "foobar.value " $(date +%s) #Populate a value, here unix-timestamp
Create the cache directory, '/var/cache/librenms/' and make sure Create the cache directory, '/var/cache/librenms/' and make sure
that it is owned by the user running the SNMP daemon. that it is owned by the user running the SNMP daemon.
``` ```
mkdir -p /var/cache/librenms/ mkdir -p /var/cache/librenms/
``` ```
@@ -1054,13 +1002,11 @@ The MySQL script requires PHP-CLI and the PHP MySQL extension, so
please verify those are installed. please verify those are installed.
CentOS (May vary based on PHP version) CentOS (May vary based on PHP version)
``` ```
yum install php-cli php-mysql yum install php-cli php-mysql
``` ```
Debian (May vary based on PHP version) Debian (May vary based on PHP version)
``` ```
apt-get install php-cli php-mysql apt-get install php-cli php-mysql
``` ```
@@ -1123,7 +1069,6 @@ NGINX is a free, open-source, high-performance HTTP server: <https://www.nginx.o
It's required to have the following directive in your nginx It's required to have the following directive in your nginx
configuration responsible for the localhost server: configuration responsible for the localhost server:
```text ```text
location /nginx-status { location /nginx-status {
stub_status on; stub_status on;
@@ -1172,8 +1117,7 @@ Export the NFS stats from as server.
``` ```
extend nfs-server /bin/cat /proc/net/rpc/nfsd extend nfs-server /bin/cat /proc/net/rpc/nfsd
``` ```
>find out where cat is located using : `which cat`
note : find out where cat is located using : `which cat`
2. reload snmpd service to activate the configuration 2. reload snmpd service to activate the configuration
@@ -1434,15 +1378,11 @@ chmod +x /etc/snmp/portactivity
``` ```
extend portactivity /etc/snmp/portactivity -p http,ldap,imap extend portactivity /etc/snmp/portactivity -p http,ldap,imap
``` ```
>Will monitor HTTP, LDAP, and IMAP. The -p switch specifies what ports to use. This is a comma seperated list.
Will monitor HTTP, LDAP, and IMAP. The -p switch specifies what ports >
to use. This is a comma seperated list. >These must be found in '/etc/services' or where ever NSS is set to fetch it from. If not, it will throw an error.
>
These must be found in '/etc/services' or where ever NSS is set to >If you want to JSON returned by it to be printed in a pretty format use the -P flag.
fetch it from. If not, it will throw an error.
If you want to JSON returned by it to be printed in a pretty format
use the -P flag.
5. Restart snmpd on your host. 5. Restart snmpd on your host.