Synology SNMP Network Monitoring with LibreNMS Docker
Posted On
2017 Dec 09
over 6 years ago
Updated On
2023 Oct 07
7 months ago
Afterword
Thank you for reading!
Hope this tutorial was helpful to anyone looking to deploying an NMS to monitor devices, be it for personal home or business use
As of current, I have a production LibreNMS installed precisely as written in this tutorial, ready to alert our telco's NOC department when a monitored business line is suffering from downtime
You can contact me by leaving a comment on this site via Discourse or Discord server @
What follows are my thoughts and experiences
Why Docker?
Packaged Web Server
Go through
This tutorial was written at that point in time when I was still new to Terminals and Linux. Since then I have already stepped up my installation to a 3 point distributed LibreNMS setup
The best part? I am still using Docker containers
Using jarischaefer's image has helped a great deal as the image already contains the web server, RRD and memcached installed and working properly. Thank you jarischaefer!
Multiple Containers in a Single Host
Using Docker also has its other merits, looking at my tutorial screenshots, you can see that I am doing a fresh test install of MariaDB/LibreNMS under mariadb-test/librenms-test on different ports
What this means is that, you can actually run more than one LibreNMS/MariaDB containers on the same host
This 'host' can be a machine (Server, Computer & Laptop), Synology NAS (this tutorial) or a Virtual Machine
If you are here, you've probably seen the rise of Docker/Kubernetes/Stacks etc
With Docker we can deploy X number of Containers with different settings, depending on your host performance of course
Taking this tutorial, for example, I could set up:
x1 LibreNMS-1 running on port 8668 x1 MariaDB-1 for Libre8668
and another
x1 LibreNMS-2 running on port 8669 x1 MariaDB-2 for Libre8669
All running in one host (Synology), and still have room to spare for other containers
One Point of Failure?
Whether you would want this setup or not, is entirely up to your budget, organization, policies, performance and the number of SNMP devices you wish to monitor
Home Use
- Tighter Budget or use what is already available
- Very narrow WAF (Wife Acceptance Factor) range to play with ;)
- Works best with x1 Server or x1 NAS capable of running Docker
Homelabbers
- You are probably running some crazy stuffs already like netdata, Prometheus, Grafana, ELK
- Spin a VM up just for LibreNMS/MariaDB
- Or, since we are using Docker, run it with another Debian/Linux host to save some vCPU
SMBs/Enterprises
You might not even be here in the first place :) If you are looking for an Open Source solution, reach out to the LibreNMS team for professional support. Or donate to the team once you have set up your NMS systems
You will most probably NOT want to use this tutorial to deploy LibreNMS in a production environment
Deploying their official instructions will give you automatic updates and not rely on a 3rd party Docker Image
If you still want to deploy via Docker, use LibreNMS's
Planning & Setting ahead
If you are new to all of this and just starting out (which we all do at some point), it is very important that you take some time to plan ahead and also know what to expect
Networking
Get your server/NAS properly communicating with other devices first!
Local Networks
Home / Homelab environments are usually local networks. If you have VLANs on them, ensure you've properly configured Inter-VLAN routing between them. Complicated word, just means configure your firewall to allow packets from one VLAN to another VLAN. Period. (The usual firewall ruling apply)
Remote & VPNs & Routers
Usually recommended to setup VPN in the router level, so that your devices behind the router can communicate with a remote server via VPN without setting up a VPN client
Home / Testing Use
If you want to see what LibreNMS or SNMP, in general, has to offer, following this tutorial as written with minimum hardware will most definitely work
- Hardware
- A server (or NAS with docker capabilities)
- Device to monitor
- The server itself that runs LibreNMS
Production Use
"Production"? Just means for serious, non-testing, stable working environments. However you want to use this for home or business, it doesn't matter. You will need to properly set up your systems and already have a basic/firm knowledge of networking.
As written in the post, most problems happen with networking itself, not the installation of LibreNMS via Docker, with containers being easy to deploy
Some tips & hints
-
Resist the need to upgrade every time! Read the changelog for major changes/updates that are relevant to your system/setup before upgrading
-
Use a fixed version image on your containers to prevent any problems due to update. If a hardware failure happens, your saved Docker run commands will most definitely work again. But if you were to use the latest tag, your previous Docker run commands, configurations/settings might not be compatible with the latest image, as compared to your initial configuration (say, 6months to a year ago)
-
Eg: Use a stable fixed tag MySQL/MariaDB image rather than the latest tag
Set, Analyze & Forget
During my initial successful setup, it became a daily routine to check LibreNMS by opening the mobile myLibreNMS app. Setup your notifications/alerts properly, and you won't need to visit the LibreNMS GUI as much (or maybe deep down I want something to happen...?)
Other than waiting on the graphs to fill and producing some eye candy, monitoring my devices did help me in the following:
- Alert when a device goes down
- When one of the APs at home goes down due to someone switching it off and forgetting to turn it back on, resulting in poor home Wi-Fi reception
- Alert/notification kicks in, and provided instructions to family members to switch on the AP... all while I'm overseas
- When one of the APs at home goes down due to someone switching it off and forgetting to turn it back on, resulting in poor home Wi-Fi reception
- Alert when a business line goes down
- Whenever a business line is down for 30minutes, an email gets sent automatically to the NOC department, with an internal company email sent to notify staffs about the imminent downtime. Recovery email gets sent to notify NOC and staffs that the line is back up
- Alert when your storage is almost full
- For those sensitive Linux systems before havoc sets in
- Re-evaluate whether your device is having a rough/tough time
- Temperatures
- CPU, RAM, Storage
- UPS load
Discourse Memory on DigitalOcean Droplet Swap
Just came back ONCE AGAIN to use your Guide, as i’ve been getting a dozen of customer’s on my own consulting company, where i do network, but dont understand databases.
now your Librenms/MariaDB guide just gave me a little something xtra to use when it comes to monitoring.
im not relying on the tool as im a sole beginner on this platform, so im using it and the Dessert when it comes to monitoring customer’s device health 
Thank you so much for using this guide.!
once AGAIN im thanking you
Hi Jason. Not yet… ive been so busy i havent had the time yet to take a look at it.
since im not a great Docker/librenms expert i need several hours available before i can dive into it so i can learn 
But if you wanna take a quick look and make a little buck, let me know
ive started hosting a lot of server this week for customer so i might as well get those added to Librenms too, but right now im doing it on an IP address level, which will get confusing once i get added a ton of devices the host synology can ping dns names without a sweat but apparantly the bridge thing here is messing with me again
Hope youre enjoying the weekend man.
Hay @jasonloong, thanks for spending time looking into this. Good news, I have it working now! Bad news, I’m not entirely sure what actually fixed it 
Don’t you hate it when that happens?
For info, here’s all I get now from validate.php, but as I say now happily creating custom dashboards.
====================================
Component | Version
--------- | -------
LibreNMS | 1.63
DB Schema | 2020_04_19_010532_eventlog_sensor_reference_cleanup (164)
PHP | 7.4.5
MySQL | 10.4.12-MariaDB-1:10.4.12+maria~bionic
RRDTool | 1.7.0
SNMP | NET-SNMP 5.7.3
====================================
[OK] Composer Version: 1.10.5
[OK] Dependencies up-to-date.
[OK] Database connection successful
[OK] Database schema correct
[WARN] IPv6 is disabled on your server, you will not be able to add IPv6 devices.
[WARN] Your install is over 24 hours out of date, last update: Tue, 28 Apr 2020 03:52:42 +0000
[FIX]:
Make sure your daily.sh cron is running and run ./daily.sh by hand to see if there are any errors.
[WARN] Your local git branch is not master, this will prevent automatic updates.
[FIX]:
You can switch back to master with git checkout master
Seems like a great doc, unfortunately once I do the initial mariadb container install, the container goes into a continuous restart cycle. This is the first and only container install I’ve done on this NAS. I’ve removed and tried now three times with the same result each time.
Ideas???
Thanks
@beaker sorry for the second ping, forums was down during a misconfig on pfSense on my end, making sure email get sent to you
I think I figured it out (with your help). When I used your run statement, the container didn’t start. But there were a couple log entries.
root@synology:/volume1/docker# docker logs mariadb
2020-05-07 19:44:41-07:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 1:10.4.12+maria~bionic started.
2020-05-07 19:44:42-07:00 [Note] [Entrypoint]: Switching to dedicated user ‘mysql’
2020-05-07 19:44:42-07:00 [Note] [Entrypoint]: Entrypoint script for MySQL Server 1:10.4.12+maria~bionic started.
2020-05-07 19:44:43-07:00 [ERROR] [Entrypoint]: Database is uninitialized and password option is not specified
You need to specify one of MYSQL_ROOT_PASSWORD, MYSQL_ALLOW_EMPTY_PASSWORD and MYSQL_RANDOM_ROOT_PASSWORD
I had a password in the run statement, but I was using a special character. Once I removed that special char, it worked fine w/ Jason’s original run statement.
Continuing on…
-Daren
Oh, sorry for being so concise 
My set up is so simply:
Synology NAS with Librenms docker.
The Synology firewall is off.
Moikrotik router.
All output traffic it’s allowed.
Maybe I can try with the Google SMTP server 
When I click the test I obtain this 
But, if I configure a printer to alert directly, with the same config, the printer alert correctly.
hi all, an update to recent test deployment of jarischaefer’s LibreNMS image,
its broken on both Synology and general Debian installs
Do NOT update to latest image
Do NOT update to latest image if you doing maintenance of your containers
Tested on:
Syno 916+
DSM 6.2.3-25426
| Version | 1.65.1 - Sat Jul 11 2020 03:56:16 GMT+0800 |
|---|---|
| Database Schema | 2020_06_23_00522_alter_availability_perc_column (170) |
| Web Server | nginx/1.15.8 |
| PHP | 7.4.7 |
| Python | 3.6.9 |
| MySQL | 10.4.12-MariaDB-1:10.4.12+maria~bionic |
| Laravel | 6.18.20 |
| RRDtool | 1.7.0 |
Discovery works but never polls after
Test with Ubuntu VM
Distributor ID: Ubuntu
Description: Ubuntu 18.04.4 LTS
Release: 18.04
Codename: bionic
Thought I’d test this image in a VM to cancel out some Syno permission problems to make sure the image is working
poller-wrapper.py error
Latest working version: 1.63
If anyone tested with the latest version and works, would appreciate if they could report with any work arounds/solutions
For new users deploying a fresh install, I’ve tested from latest, v1.65, v.1.64, with poller-wrappy.py errors, please use v1.63
Version 1.63 - Tue Apr 28 2020 11:52:42 GMT+0800
Database Schema 2020_04_19_010532_eventlog_sensor_reference_cleanup (164)
Web Server nginx/1.15.8
PHP 7.4.5
MySQL 10.5.4-MariaDB-1:10.5.4+maria~focal
RRDtool 1.7.0
Eg:
docker pull jarischaefer/docker-librenms:1.63
Meanwhile I’ll go report to jarischaefer
Tutorial updated to working
Details are on the tutorial changelog
Github Issue details:
Latest working, testing, Docker deployment of LibreNMS (fresh install)
MariaDB
docker run \
-v /volume1/docker/mariadb:/var/lib/mysql \
-e MYSQL_ROOT_PASSWORD=root_password \
-e TZ=Asia/Singapore \
--name mariadb \
-d \
--restart always \
mariadb:latest \
--innodb_file_per_table=1 \
--lower_case_table_names=0
LibreNMS
docker run \
-p 8668:80 \
-e DB_HOST=libredb \
-e DB_NAME=librenms \
-e DB_USER=librenms \
-e DB_PASS=libre_password \
-e APP_KEY=base64:THE_GENERATED_KEY \
-e BASE_URL=http://YOUR_NAS_IP:8668 \
-e TZ=Asia/Singapore \
--link mariadb:libredb \
-v /volume1/docker/librenms/logs:/opt/librenms/logs \
-v /volume1/docker/librenms/rrd:/opt/librenms/rrd \
-v /volume1/docker/librenms/custom.config.php:/opt/librenms/conf.d/custom.config.php:ro \
--name librenms \
-d \
--restart always \
jarischaefer/docker-librenms:latest
Yes, if you have a different username created for librenms, please update the command accordingly
Hi!
Thanks! I got it working… FYI, I also had to change these steps:
APPKEY COMMAND
Not sure if needed, but I edited the command to use that specific version, like this:
docker run --rm jarischaefer/docker-librenms:23.5.0 generate_key
ADMIN USER COMMAND
This command:
docker exec librenms create_admin
Returns this error:
Could not open input file: /opt/librenms/adduser.php
But I used this method instead: in the Synology Container manager, I opened a terminal window and issued this command:
sudo -u librenms lnms user:add -p [password] -r admin [username]
This worked, and I can now login… I have absolutely no idea what to do next hahaha, but I’m sure I’ll figure out how LibreNMS works 
If you found this tutorial to be useful, your comments or
are most appreciated!
Stuck and need help/pointers with this tutorial? Comment in the forum powered by Discourse