NOTE: These instructions assume you are the root user. If you are not, prepend
sudoto the shell commands (the ones that aren't at
mysql>prompts) or temporarily become a user with root privileges with
Please note the minimum supported PHP version is 8.1.
The guide below might not have been updated to reflect it!
Install Required Packages
apt install acl apache2 composer fping git graphviz imagemagick libapache2-mod-php7.0 mariadb-client mariadb-server mtr-tiny nmap php7.0-cli php7.0-curl php7.0-gd php7.0-json php7.0-mbstring php7.0-mcrypt php7.0-mysql php7.0-snmp php7.0-xml php7.0-zip python-memcache python-mysqldb rrdtool snmp snmpd whois
Add librenms user
useradd librenms -d /opt/librenms -M -r usermod -a -G librenms www-data
cd /opt composer create-project --no-dev --keep-vcs librenms/librenms librenms dev-master
systemctl restart mysql mysql -uroot -p
NOTE: Please change the 'password' below to something secure.
CREATE DATABASE librenms CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; CREATE USER 'librenms'@'localhost' IDENTIFIED BY 'password'; GRANT ALL PRIVILEGES ON librenms.* TO 'librenms'@'localhost'; FLUSH PRIVILEGES; exit
[mysqld] section please add:
systemctl restart mysql
Ensure date.timezone is set in php.ini to your preferred time zone. See https://php.net/manual/en/timezones.php for a list of supported timezones. Valid examples are: "America/New_York", "Australia/Brisbane", "Etc/UTC".
vi /etc/php/7.0/apache2/php.ini vi /etc/php/7.0/cli/php.ini
a2enmod php7.0 a2dismod mpm_event a2enmod mpm_prefork phpenmod mcrypt
Add the following config, edit
ServerName as required:
<VirtualHost *:80> DocumentRoot /opt/librenms/html/ ServerName librenms.example.com AllowEncodedSlashes NoDecode <Directory "/opt/librenms/html/"> Require all granted AllowOverride All Options FollowSymLinks MultiViews </Directory> </VirtualHost>
NOTE: If this is the only site you are hosting on this server (it should be :)) then you will need to disable the default site.
a2ensite librenms.conf a2enmod rewrite systemctl restart apache2
cp /opt/librenms/snmpd.conf.example /etc/snmp/snmpd.conf vi /etc/snmp/snmpd.conf
Edit the text which says
RANDOMSTRINGGOESHERE and set your own community string.
curl -o /usr/bin/distro https://raw.githubusercontent.com/librenms/librenms-agent/master/snmp/distro chmod +x /usr/bin/distro systemctl restart snmpd
cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms
NOTE: Keep in mind that cron, by default, only uses a very limited set of environment variables. You may need to configure proxy variables for the cron invocation. Alternatively adding the proxy settings in config.php is possible too. The config.php file will be created in the upcoming steps. Review the following URL after you finished librenms install steps: https://docs.librenms.org//Support/Configuration/#proxy-support
Copy logrotate config
LibreNMS keeps logs in
/opt/librenms/logs. Over time these can become large and be rotated out. To rotate out the old logs you can use the provided logrotate config file:
cp /opt/librenms/misc/librenms.logrotate /etc/logrotate.d/librenms
chown -R librenms:librenms /opt/librenms setfacl -d -m g::rwx /opt/librenms/rrd /opt/librenms/logs /opt/librenms/bootstrap/cache/ /opt/librenms/storage/ setfacl -R -m g::rwx /opt/librenms/rrd /opt/librenms/logs /opt/librenms/bootstrap/cache/ /opt/librenms/storage/
Now head to the web installer and follow the on-screen instructions.
The web installer might prompt you to create a
config.php file in your librenms install location manually, copying the content displayed on-screen to the file. If you have to do this, please remember to set the permissions on config.php after you copied the on-screen contents to the file. Run:
chown librenms:librenms /opt/librenms/config.php
That's it! You now should be able to log in to http://librenms.example.com/. Please note that we have not covered HTTPS setup in this example, so your LibreNMS install is not secure by default. Please do not expose it to the public Internet unless you have configured HTTPS and taken appropriate web server hardening steps.
Add the first device
We now suggest that you add localhost as your first device from within the WebUI.
If you ever have issues with your install, run validate.php as root in the librenms directory:
cd /opt/librenms ./validate.php
There are various options for getting help listed on the LibreNMS web site: https://www.librenms.org/#support
Now that you've installed LibreNMS, we'd suggest that you have a read of a few other docs to get you going:
We hope you enjoy using LibreNMS. If you do, it would be great if you would consider opting into the stats system we have, please see this page on what it is and how to enable it.