docker-librenms

Docker image for LibreNMS

About

This is a generic docker container for LibreNMS.

The container runs nginx 1.13+ with HTTP/2 support and PHP 7.2 FPM with OPCache and rrdcached for maximum performance.

Basic commands to run the container

docker run \
	-d \
	-h librenms \
	-p 80:80 \
	-e DB_HOST=db \
	-e DB_NAME=librenms \
	-e DB_USER=librenms \
	-e DB_PASS=secret \
	-e BASE_URL=http://localhost \
	-e POLLERS=16 \
	-e TZ=UTC \
	--link my-database-container:db \
	-v /data/logs:/opt/librenms/logs \
	-v /data/rrd:/opt/librenms/rrd \
	--name librenms \
	jarischaefer/docker-librenms

Initial setup

Database configuration

If you don't have a MySQL server setup either in Docker or elsewhere then you can create a docker container here.

You should read the LibreNMS installation docs for the latest instructions regarding database setup.

As of November 2016, the following is still a requirement:

NOTE: Whilst we are working on ensuring LibreNMS is compatible with MySQL strict mode, for now, please disable this after mysql is installed.

Database schema

Make sure the database exists before running these commands.

Creating the tables:

docker exec librenms sh -c "cd /opt/librenms && php /opt/librenms/build-base.php"

Creating an initial admin user:

docker exec librenms php /opt/librenms/adduser.php admin admin 10 test@example.com

SSL

Mount another directory containing ssl.key, ssl.crt and optionally ssl.ocsp.crt to enable HTTPS. You'll also have to change BASE_URL.

docker run \
	-d \
	-h librenms \
	-p 80:80 \
	-p 443:443 \
	-e DB_HOST=db \
	-e DB_NAME=librenms \
	-e DB_USER=librenms \
	-e DB_PASS=secret \
	-e BASE_URL=https://localhost \
	-e POLLERS=16 \
	-e TZ=UTC \
	--link my-database-container:db \
	-v /data/logs:/opt/librenms/logs \
	-v /data/rrd:/opt/librenms/rrd \
	-v /data/ssl:/etc/nginx/ssl:ro \
	--name librenms \
	jarischaefer/docker-librenms

Environment config

The following keys can be passed directly via the -e switch:

Basic configuration

Key	Default	Description
BASE_URL		Base URL for LibreNMS (e.g. http://192.168.0.1:8080)
DB_HOST		MySQL IP or hostname
DB_PORT	3306	MySQL port
DB_NAME		MySQL database name
DB_USER		MySQL user
DB_PASS		MySQL password
TZ	UTC	Timezone (e.g. Europe/Zurich)

Enabling/disabling container features

Key	Default	Description
DISABLE_IPV6	false	Disable nginx IPv6 socket
MEMCACHED_ENABLE	false	Enable memcached
MEMCACHED_HOST		memcached IP or hostname
MEMCACHED_PORT	11211	memcached port
NGINX_ENABLE	true	Enable nginx
PHPFPM_ENABLE	true	Enable PHP-FPM
RRDCACHED_ENABLE	true	Enable rrdcached
RRDCACHED_CONNECT	unix:/var/run/rrdcached/rrdcached.sock	rrdcached TCP or unix socket where LibreNMS connects to
RRDCACHED_LISTEN	unix:/var/run/rrdcached/rrdcached.sock	rrdcached TCP or unix socket where rrdcached listens on
SKIP_CHOWN	false	Disable (slow) chowning of files at startup (might help with network storage)

Enabling/disabling LibreNMS features

Key	Default	Description
ALERTS_ENABLE	true	Enable LibreNMS alerts
BILLING_CALCULATE_ENABLE	true	Enable LibreNMS billing calculation
CHECK_SERVICES_ENABLE	true	Enable LibreNMS service checks
DAILY_ENABLE	true	Enable LibreNMS daily script
DISCOVERY_ENABLE	true	Enable LibreNMS discovery
DISCOVERY_THREADS	1	Number of threads for discovery
ENABLE_SYSLOG	false	Enable LibreNMS syslog (see here)
POLL_BILLING_ENABLE	true	Enable LibreNMS billing polling
POLLERS_ENABLE	true	Enable LibreNMS polling
POLLERS	8	Number of LibreNMS pollers
SNMP_SCAN_ENABLE	false	Enable cron for snmp-scan
SNMP_SCAN_CRON	0 0 * * *	Cron schedule for snmp-scan

syslog

These are instructions for the LibreNMS syslog extension.

• Pass ENABLE_SYSLOG=true
• Publish port 514 (both TCP and UDP)
• Configure the remote host whose logs should be gathered (rsyslog example)
  • Create /etc/rsyslog.d/60-librenms.conf
  • Add *.* @example.com:514

Custom config

You may apply custom configuration by mounting files matching *.php in /opt/librenms/conf.d.

Notice config.interfaces.php below:

docker run \
	-d \
	-h librenms \
	-p 80:80 \
	-p 443:443 \
	-e DB_HOST=db \
	-e DB_NAME=librenms \
	-e DB_USER=librenms \
	-e DB_PASS=secret \
	-e BASE_URL=https://localhost \
	-e POLLERS=16 \
	-e TZ=UTC \
	--link my-database-container:db \
	-v /data/logs:/opt/librenms/logs \
	-v /data/rrd:/opt/librenms/rrd \
	-v /data/ssl:/etc/nginx/ssl:ro \
	-v /data/config.interfaces.php:/opt/librenms/conf.d/config.interfaces.php \
	--name librenms \
	jarischaefer/docker-librenms

config.interfaces.php:

<?php

$config['bad_if_regexp'][] = '/^docker[-\w].*$/';
$config['bad_if_regexp'][] = '/^lxcbr[0-9]+$/';
$config['bad_if_regexp'][] = '/^veth.*$/';
$config['bad_if_regexp'][] = '/^virbr.*$/';
$config['bad_if_regexp'][] = '/^lo$/';
$config['bad_if_regexp'][] = '/^macvtap.*$/';
$config['bad_if_regexp'][] = '/gre.*$/';
$config['bad_if_regexp'][] = '/tun[0-9]+$/';

Disabling cron jobs or the local rrdcached instance

If you plan to use this container for a distributed LibreNMS installation, you may want to disable some of the default cron jobs, or the local rrdcached, nginx and php-fpm services. You could also increase the number of discovery-wrapper.py threads.

docker run \
	-d \
	-h librenms \
	-p 80:80 \
	-e DB_HOST=db \
	-e DB_NAME=librenms \
	-e DB_USER=librenms \
	-e DB_PASS=secret \
	-e BASE_URL=http://localhost \
	-e POLLERS=16 \
	-e TZ=UTC \
	-e DISCOVERY_THREADS=2 \
	-e DAILY_ENABLE=false \
	-e ALERTS_ENABLE=false \
	-e CHECK_SERVICES_ENABLE=false \
	-e RRDCACHED_ENABLE=false \
	-e NGINX_ENABLE=false \
	-e PHPFPM_ENABLE=false \
	--link my-database-container:db \
	-v /data/logs:/opt/librenms/logs \
	-v /data/rrd:/opt/librenms/rrd \
	--name librenms \
	jarischaefer/docker-librenms

Executing commands inside the container

Make sure you source the environment variables from /etc/librenms_environment prior to executing commands inside the container.

This is an example demonstrating how to run the validation script.

su - librenms
source /etc/librenms_environment
cd /opt/librenms
php validate.php

Running in production

The commands above are purely for illustrative purposes. You should customize them to fit your environment.

Also, please note that...

• Alerting via email is supported via SMTP only.
• Publicly accessible installations should be put behind jwilder/nginx-proxy or similar proxies for better access control and security hardening.

License

This project is open-sourced software licensed under the MIT license.

LibreNMS has its own license, this license only covers the Docker part.