Sophia/librenms-speedtest
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add instructions

Browse Source
This commit is contained in:
Jack Greyhat
2021-01-28 13:48:37 +01:00
parent 963fb5f95b
commit 2d2d18f468
1 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -8,13 +8,15 @@ Screenshot:<br/>
<img src="https://gitlab.com/jackgreyhat/librenms-speedtest/-/raw/master/images/dashboard-screenshot.png" width="800" height="400"/> <img src="https://gitlab.com/jackgreyhat/librenms-speedtest/-/raw/master/images/dashboard-screenshot.png" width="800" height="400"/>
<br/> <br/>
## Installation ## Installation
### Prerequisites ### Plugin Prerequisites
- A working LibreNMS installation :D - A working LibreNMS installation. :D
- Shell access to the LibreNMS server - Shell access to the LibreNMS server.
- Speedtest CLI by Ookla. To install this, use the following link and instructions: - Speedtest CLI by Ookla. To install this, use the following link and instructions:
- https://www.speedtest.net/apps/cli - https://www.speedtest.net/apps/cli
- Verify you are running Speedtest CLI by Ookla by issuing the following command on your CLI:<br/> - Verify you are running Speedtest CLI by Ookla by issuing the following command on your CLI:<br/>
`speedtest --version` <br/> ```
speedtest --version
```
Expected example output: <br/> Expected example output: <br/>
``` ```
Speedtest by Ookla 1.0.0.2 (5ae238b) Linux/x86_64-linux-musl 5.4.0-64-generic x86_64 Speedtest by Ookla 1.0.0.2 (5ae238b) Linux/x86_64-linux-musl 5.4.0-64-generic x86_64
@ -27,5 +29,17 @@ Screenshot:<br/>
There is also the "speedtest-cli" package, which is possibly provided by your distribution's repository. This package, however, does not follow the same cli commands as the Ookla's Speedtest CLI package and is built with Python. It is known to under perform in some cases.<br/> There is also the "speedtest-cli" package, which is possibly provided by your distribution's repository. This package, however, does not follow the same cli commands as the Ookla's Speedtest CLI package and is built with Python. It is known to under perform in some cases.<br/>
This dashboard will not work out of the box with the "speedtest-cli" package. Prefer to install Ookla's package. This dashboard will not work out of the box with the "speedtest-cli" package. Prefer to install Ookla's package.
### Plugin Installation
NOTE: These instructions assume you are the root user. If you are not, prepend sudo to the shell commands or temporarily become a user with root privileges.
- Login to your LibreNMS' server CLI.
- Go to your home dir: `cd ~/`
- Clone this repository into your home dir: `git clone https://gitlab.com/jackgreyhat/librenms-speedtest.git`
- Create the plugin directory into LibreNMS' plugin folder: `mkdir /opt/librenms/html/plugins/Speedtest`
- Copy the LibreNMS speedtest plugin contents into the newly created directory: `cp -r ~/librenms-speedtest/. /opt/librenms/html/plugins/Speedtest`
- Ensure correct ownership and permissions on the Speedtest plugin directory and files:
```
chown -R librenms:librenms /opt/librenms/html/plugins/Speedtest
chmod -R --reference=/opt/librenms/html/plugins/Test /opt/librenms/html/plugins/Speedtest
chmod +x /opt/librenms/html/plugins/Speedtest/librenms-speedtest.sh
```