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

Consolidated doc (Ubuntu 20.04 Nginx tested)

Browse Source
This commit is contained in:
Tony Murray
2020-05-31 21:45:39 -05:00
parent ec50217173
commit 841203c8c5
5 changed files with 635 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

592
doc/Installation/Install-LibreNMS.md Normal file
View File

@@ -0,0 +1,592 @@
source: Installation/Install-LibreNMS.md
path: blob/master/doc/
This documentation has support for multiple OS/web server options. Make sure
you select the same option when they are presented.
> NOTE: These instructions assume you are the **root** user. If you
> are not, prepend `sudo` to the shell commands (the ones that aren't
> at `mysql>` prompts) or temporarily become a user with root
> privileges with `sudo -s` or `sudo -i`.
**Please note the minimum supported PHP version is 7.2.5**
# Install Required Packages
=== "Ubuntu 20.04"
=== "Nginx"
```
apt install software-properties-common
add-apt-repository universe
apt update
apt install acl curl composer fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php7.4-cli php7.4-curl php7.4-fpm php7.4-gd php7.4-json php7.4-mbstring php7.4-mysql php7.4-snmp php7.4-xml php7.4-zip rrdtool snmp snmpd whois unzip python3-pymysql python3-dotenv python3-redis python3-setuptools
```
=== "Apache"
```
apt install software-properties-common
add-apt-repository universe
apt update
apt install acl curl apache2 composer fping git graphviz imagemagick libapache2-mod-php7.2 mariadb-client mariadb-server mtr-tiny nmap php7.2-cli php7.2-curl php7.2-gd php7.2-json php7.2-mbstring php7.2-mysql php7.2-snmp php7.2-xml php7.2-zip python-memcache python-mysqldb rrdtool snmp snmpd whois python3-pip
```
# Add librenms user
```
useradd librenms -d /opt/librenms -M -r -s /usr/bin/bash
usermod -a -G librenms www-data
```
=== "CentOS 8"
=== "Nginx"
```
yum install epel-release yum-utils
yum localinstall http://rpms.remirepo.net/enterprise/remi-release-7.rpm
yum-config-manager --enable remi-php73
yum install composer cronie fping git ImageMagick jwhois mariadb mariadb-server mtr MySQL-python net-snmp net-snmp-utils nginx nmap php-fpm php-cli php-common php-curl php-gd php-mbstring php-process php-snmp php-xml php-zip php-memcached php-mysqlnd python-memcached rrdtool python3 python3-pip
```
=== "Apache"
```
yum install epel-release
yum install git cronie fping jwhois ImageMagick mtr MySQL-python net-snmp net-snmp-utils nmap python-memcached rrdtool policycoreutils-python httpd mariadb mariadb-server unzip python3 python3-pip
```
# Add librenms user
```
useradd librenms -d /opt/librenms -M -r -s /usr/bin/bash
usermod -a -G librenms nginx
```
=== "Debian 10"
=== "Nginx"
```
apt install curl composer fping git graphviz imagemagick mariadb-client mariadb-server mtr-tiny nginx-full nmap php7.3-cli php7.3-curl php7.3-fpm php7.3-gd php7.3-json php7.3-mbstring php7.3-mysql php7.3-snmp php7.3-xml php7.3-zip python-memcache python-mysqldb rrdtool snmp snmpd whois python3-pymysql python3-dotenv python3-redis python3-setuptools
```
# Add librenms user
```
useradd librenms -d /opt/librenms -M -r -s /usr/bin/bash
usermod -a -G librenms www-data
```
# Download LibreNMS
```
cd /opt
git clone https://github.com/librenms/librenms.git
```
# Set permissions
```
chown -R librenms:librenms /opt/librenms
chmod 770 /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/
```
# Install PHP dependencies
```
su - librenms
./scripts/composer_wrapper.php install --no-dev
exit
```
# DB Server
## Configure MySQL
```
systemctl start mariadb
mysql -u root
```
> NOTE: Change the 'password' below to something secure.
```sql
CREATE DATABASE librenms CHARACTER SET utf8 COLLATE utf8_unicode_ci;
CREATE USER 'librenms'@'localhost' IDENTIFIED BY 'password';
GRANT ALL PRIVILEGES ON librenms.* TO 'librenms'@'localhost';
FLUSH PRIVILEGES;
exit
```
=== "Ubuntu 20.04 / Debian 10"
```
vi /etc/mysql/mariadb.conf.d/50-server.cnf
```
=== "CentOS 8"
```
vi /etc/my.cnf
```
Within the `[mysqld]` section please add:
```bash
innodb_file_per_table=1
lower_case_table_names=0
```
```
systemctl enable mariadb
systemctl restart mariadb
```
# Web Server
## Configure PHP
### Set timezone
See <http://php.net/manual/en/timezones.php> for a list of supported
timezones. Valid examples are: "America/New_York", "Australia/Brisbane", "Etc/UTC".
Please remember to set the system timezone as well.
```
timedatectl set-timezone Etc/UTC
```
Ensure date.timezone is set in php.ini to your preferred time zone.
=== "Ubuntu 20.04"
=== "Nginx"
```bash
vi /etc/php/7.4/fpm/php.ini
vi /etc/php/7.4/cli/php.ini
```
```bash
systemctl restart php7.4-fpm
```
## Configure NGINX
```bash
vi /etc/nginx/conf.d/librenms.conf
```
Add the following config, edit `server_name` as required:
```nginx
server {
listen 80;
server_name librenms.example.com;
root /opt/librenms/html;
index index.php;
charset utf-8;
gzip on;
gzip_types text/css application/javascript text/javascript application/x-javascript image/svg+xml text/plain text/xsd text/xsl text/xml image/x-icon;
location / {
try_files $uri $uri/ /index.php?$query_string;
}
location /api/v0 {
try_files $uri $uri/ /api_v0.php?$query_string;
}
location ~ \.php {
include fastcgi.conf;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php/php7.4-fpm.sock;
}
location ~ /\.ht {
deny all;
}
}
```
```bash
rm /etc/nginx/sites-enabled/default
systemctl restart nginx
```
=== "Apache"
```bash
vi /etc/php/7.4/apache2/php.ini
vi /etc/php/7.4/cli/php.ini
a2enmod php7.4
a2dismod mpm_event
a2enmod mpm_prefork
```
## Configure Apache
```bash
vi /etc/apache2/sites-available/librenms.conf
```
Add the following config, edit `ServerName` as required:
```apache
<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. `a2dissite 000-default`
```bash
a2ensite librenms.conf
a2enmod rewrite
systemctl restart apache2
```
=== "Debian 10"
=== "Nginx"
```bash
vi /etc/php/7.3/fpm/php.ini
vi /etc/php/7.3/cli/php.ini
```
```bash
systemctl restart php7.3-fpm
```
## Configure NGINX
```bash
rm /etc/nginx/sites-available/default && rm /etc/nginx/sites-enabled/default
vi /etc/nginx/sites-enabled/librenms.vhost
```
Add the following config, edit `server_name` as required:
```nginx
server {
listen 80;
server_name librenms.example.com;
root /opt/librenms/html;
index index.php;
charset utf-8;
gzip on;
gzip_types text/css application/javascript text/javascript application/x-javascript image/svg+xml text/plain text/xsd text/xsl text/xml image/x-icon;
location / {
try_files $uri $uri/ /index.php?$query_string;
}
location /api/v0 {
try_files $uri $uri/ /api_v0.php?$query_string;
}
location ~ \.php {
include fastcgi.conf;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/var/run/php/php7.3-fpm.sock;
}
location ~ /\.ht {
deny all;
}
}
```
```bash
systemctl reload nginx
```
=== "CentOS 8"
=== "Nginx"
```
vi /etc/php.ini
```
In `/etc/php-fpm.d/www.conf` make these changes:
```
vi /etc/php-fpm.d/www.conf
```
```nginx
;user = apache
user = nginx
group = apache ; keep group as apache
;listen = 127.0.0.1:9000
listen = /run/php-fpm/php-fpm.sock
listen.owner = nginx
listen.group = nginx
listen.mode = 0660
```
```
systemctl enable php-fpm
systemctl restart php-fpm
```
## Configure NGINX
```
vi /etc/nginx/conf.d/librenms.conf
```
Add the following config, edit `server_name` as required:
```nginx
server {
listen 80;
server_name librenms.example.com;
root /opt/librenms/html;
index index.php;
charset utf-8;
gzip on;
gzip_types text/css application/javascript text/javascript application/x-javascript image/svg+xml text/plain text/xsd text/xsl text/xml image/x-icon;
location / {
try_files $uri $uri/ /index.php?$query_string;
}
location /api/v0 {
try_files $uri $uri/ /api_v0.php?$query_string;
}
location ~ \.php {
include fastcgi.conf;
fastcgi_split_path_info ^(.+\.php)(/.+)$;
fastcgi_pass unix:/run/php-fpm/php-fpm.sock;
}
location ~ /\.ht {
deny all;
}
}
```
> 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.
Delete the `server` section from `/etc/nginx/nginx.conf`
```
systemctl enable nginx
systemctl restart nginx
```
=== "Apache"
```
vi /etc/php.ini
```
## Configure Apache
Create the librenms.conf:
```
vi /etc/httpd/conf.d/librenms.conf
```
Add the following config, edit `ServerName` as required:
```apache
<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. `rm -f /etc/httpd/conf.d/welcome.conf`
```
systemctl enable --now httpd
```
# SELinux
=== "Ubuntu 20.04 / Debian 10"
SELinux not enabled by default
=== "CentOS 8"
Install the policy tool for SELinux:
```
yum install policycoreutils-python
```
## Configure the contexts needed by LibreNMS:
```
semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/logs(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/logs(/.*)?'
restorecon -RFvv /opt/librenms/logs/
semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/rrd(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/rrd(/.*)?'
restorecon -RFvv /opt/librenms/rrd/
semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/storage(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/storage(/.*)?'
restorecon -RFvv /opt/librenms/storage/
semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/bootstrap/cache(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/bootstrap/cache(/.*)?'
restorecon -RFvv /opt/librenms/bootstrap/cache/
setsebool -P httpd_can_sendmail=1
setsebool -P httpd_execmem 1
```
# Allow fping
Create the file http_fping.tt with the following contents. You can
create this file anywhere, as it is a throw-away file. The last step
in this install procedure will install the module in the proper
location.
```
module http_fping 1.0;
require {
type httpd_t;
class capability net_raw;
class rawip_socket { getopt create setopt write read };
}
#============= httpd_t ==============
allow httpd_t self:capability net_raw;
allow httpd_t self:rawip_socket { getopt create setopt write read };
```
Then run these commands
```
checkmodule -M -m -o http_fping.mod http_fping.tt
semodule_package -o http_fping.pp -m http_fping.mod
semodule -i http_fping.pp
```
# Allow access through firewall
=== "Ubuntu 20.04 / Debian 10"
Firewall not enabled by default
=== "CentOS 8"
```
firewall-cmd --zone public --add-service http
firewall-cmd --permanent --zone public --add-service http
firewall-cmd --zone public --add-service https
firewall-cmd --permanent --zone public --add-service https
```
# Configure snmpd
```
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 enable snmpd
systemctl restart snmpd
```
# Cron job
```
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
```
# Web installer
Now head to the web installer and follow the on-screen instructions.
<http://librenms.example.com/install.php>
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
```
# Final steps
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.
# Troubleshooting
If you ever have issues with your install, run validate.php:
```
sudo su - librenms
./validate.php
```
There are various options for getting help listed on the LibreNMS web
site: <https://www.librenms.org/#support>
# What next?
Now that you've installed LibreNMS, we'd suggest that you have a read
of a few other docs to get you going:
- [Performance tuning](http://docs.librenms.org/Support/Performance)
- [Alerting](http://docs.librenms.org/Extensions/Alerting/)
- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/)
- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/)
# Closing
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](http://docs.librenms.org/General/Callback-Stats-and-Privacy/) on
what it is and how to enable it.
If you would like to help make LibreNMS better there are [many ways to
help](http://docs.librenms.org/Support/FAQ/#what-can-i-do-to-help). You
can also [back LibreNMS on Open
Collective](https://t.libren.ms/donations).

46
doc/Installation/index.md
View File

@@ -5,33 +5,41 @@ path: blob/master/doc/
## Docker
An official LibreNMS docker image based on Alpine Linux and Nginx is available on [DockerHub](https://hub.docker.com/r/librenms/librenms/). Documentation can be found on the [Github repository](https://github.com/librenms/docker).
## Images
We have some pre-built VirtualBox images you can use to get started:
- [Virtual Machines](http://docs.librenms.org/Installation/Images/)
An official LibreNMS docker image based on Alpine Linux and Nginx is available
on [DockerHub](https://hub.docker.com/r/librenms/librenms/). Documentation can
be found on the [Github repository](https://github.com/librenms/docker).
## Manually
If you want to install manually then we have some documentation which should make it easy.
**Please note the minimum supported PHP version is 7.2.5**
This document includes instructions for:
- Ubuntu 20.04
- RHEL / CentOS 8
- Debian 10
[Install LibreNMS](Install-LibreNMS.md)
## Images
We have some pre-built VirtualBox images you can use to get started:
- [Virtual Machines](Images)
- [Ubuntu 18.04 Apache](http://docs.librenms.org/Installation/Installation-Ubuntu-1804-Apache/)
- [Ubuntu 18.04 Nginx](http://docs.librenms.org/Installation/Installation-Ubuntu-1804-Nginx/)
- [Debian 10 Nginx](http://docs.librenms.org/Installation/Installation-Debian-10-Nginx/)
- [RHEL / CentOS 7 Apache](http://docs.librenms.org/Installation/Installation-CentOS-7-Apache/)
- [RHEL / CentOS 7 Nginx](http://docs.librenms.org/Installation/Installation-CentOS-7-Nginx/)
### Old Install Docs
These install docs are no longer updated and may result in an unsuccessful install.
- [Ubuntu 16.04 Apache](http://docs.librenms.org/Installation/Installation-Ubuntu-1604-Apache/)
- [Ubuntu 16.04 Nginx](http://docs.librenms.org/Installation/Installation-Ubuntu-1604-Nginx/)
- [Debian/Ubuntu](http://docs.librenms.org/Installation/Installation-Ubuntu-1404-Apache/)
- [RHEL/CentOS](http://docs.librenms.org/Installation/Installation-CentOS-6-Apache-Nginx/)
- [Debian/Ubuntu Lighttpd](http://docs.librenms.org/Installation/Installation-Ubuntu-1404-Lighttpd/)
- [Debian/Ubuntu Nginx](http://docs.librenms.org/Installation/Installation-Ubuntu-1404-Nginx/)
- [Ubuntu 18.04 Apache](Installation-Ubuntu-1804-Apache/)
- [Ubuntu 18.04 Nginx](Installation-Ubuntu-1804-Nginx/)
- [Debian 10 Nginx](Installation-Debian-10-Nginx/)
- [RHEL / CentOS 7 Apache](Installation-CentOS-7-Apache/)
- [RHEL / CentOS 7 Nginx](Installation-CentOS-7-Nginx/)
- [Ubuntu 16.04 Apache](Installation-Ubuntu-1604-Apache/)
- [Ubuntu 16.04 Nginx](Installation-Ubuntu-1604-Nginx/)
- [Debian/Ubuntu](Installation-Ubuntu-1404-Apache/)
- [RHEL/CentOS](Installation-CentOS-6-Apache-Nginx/)
- [Debian/Ubuntu Lighttpd](Installation-Ubuntu-1404-Lighttpd/)
- [Debian/Ubuntu Nginx](Installation-Ubuntu-1404-Nginx/)

10
mkdocs.yml
View File

@@ -14,6 +14,8 @@ site_url: http://docs.librenms.org
markdown_extensions:
- pymdownx.tasklist
- pymdownx.tilde
- pymdownx.superfences
- pymdownx.tabbed
extra_css:
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css
- librenms.css
@@ -35,13 +37,9 @@ nav:
- Features: Support/Features.md
- Welcome to Observium users: General/Welcome-to-Observium-users.md
- 2. Installing:
- Installing LibreNMS: Installation/index.md
- How to install LibreNMS: Installation/index.md
- Install LibreNMS: Installation/Install-LibreNMS.md
- LibreNMS VMs: Installation/Images.md
- Ubuntu 18.04 (Nginx): Installation/Installation-Ubuntu-1804-Nginx.md
- Ubuntu 18.04 (Apache): Installation/Installation-Ubuntu-1804-Apache.md
- Debian 10 (Nginx): Installation/Installation-Debian-10-Nginx.md
- CentOS 7 (Nginx): Installation/Installation-CentOS-7-Nginx.md
- CentOS 7 (Apache): Installation/Installation-CentOS-7-Apache.md
- Migrating from Observium: Installation/Migrating-from-Observium.md
- 3. Getting started:
- Choosing a release: General/Releases.md

20
scripts/deploy-docs.sh
View File

@@ -9,21 +9,15 @@ fi
pip3 install --upgrade pip
pip3 install --user --requirement <(cat <<EOF
Click==7.0
future==0.18.2
Jinja2==2.11.1
livereload==2.6.1
lunr==0.5.6
Markdown==3.2.1
MarkupSafe==1.1.1
mkdocs==1.1
mkdocs-material==4.6.3
nltk==3.4.5
Pygments==2.5.2
pymdown-extensions==6.3
PyYAML==5.3
six==1.14.0
tornado==6.0.3
lunr==0.5.8
Markdown==3.2.2
mkdocs==1.1.2
mkdocs-material==5.2.2
nltk==3.5
pymdown-extensions==7.1
tornado==6.0.4
EOF
)

5
tests/DocsTest.php
View File

@@ -57,6 +57,11 @@ class DocsTest extends TestCase
'Installation/Installation-Ubuntu-1404-Nginx.md',
'Installation/Installation-Ubuntu-1604-Apache.md',
'Installation/Installation-Ubuntu-1604-Nginx.md',
'Installation/Installation-Ubuntu-1804-Nginx.md',
'Installation/Installation-Ubuntu-1804-Apache.md',
'Installation/Installation-Debian-10-Nginx.md',
'Installation/Installation-CentOS-7-Nginx.md',
'Installation/Installation-CentOS-7-Apache.md',
'Installation/Installing-LibreNMS.md',
'Support/Support-New-OS.md',
'Installation/Ubuntu-image.md',