Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: re-organize install docs #7424

Merged
merged 1 commit into from Oct 4, 2017
Merged

docs: re-organize install docs #7424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
171 changes: 76 additions & 95 deletions doc/Installation/Installation-CentOS-7-Apache.md
View file
Open in desktop
@@ -1,17 +1,32 @@
source: Installation/Installation-CentOS-7-Apache.md
> 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`.
> 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`.

### DB Server ###
## Install Required Packages ##

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

rpm -Uvh https://mirror.webtatic.com/yum/el7/webtatic-release.rpm

#### Install / Configure MySQL
```bash
yum install mariadb-server mariadb
systemctl restart mariadb
mysql -uroot
```
yum install composer cronie fping git httpd ImageMagick jwhois mariadb mariadb-server mtr MySQL-python net-snmp net-snmp-utils nmap php71w php71w-cli php71w-common php71w-curl php71w-gd php71w-mcrypt php71w-mysql php71w-snmp php70w-xml php71w-zip python-memcached rrdtool

#### Add librenms user

useradd librenms -d /opt/librenms -M -r
usermod -a -G librenms apache

#### Install LibreNMS

cd /opt
git clone https://github.com/librenms/librenms.git librenms

## DB Server ##

#### Configure MySQL

systemctl restart mariadb
mysql -uroot

> NOTE: Please 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';
Expand All @@ -20,66 +35,39 @@ FLUSH PRIVILEGES;
exit
```

`vim /etc/my.cnf.d/server.cnf`
vi /etc/my.cnf

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

Within the [mysqld] section please add:
Within the `[mysqld]` section please add:

```bash
innodb_file_per_table=1
sql-mode=""
lower_case_table_names=0
```
systemctl enable mariadb
systemctl restart mariadb

```
systemctl enable mariadb
systemctl restart mariadb
```
## Web Server ##

### Web Server ###
### Configure PHP

#### Install / Configure Apache
Ensure date.timezone is set in php.ini to your preferred time zone. See http://php.net/manual/en/timezones.php for a list of supported timezones. Valid examples are: "America/New_York", "Australia/Brisbane", "Etc/UTC".

```bash
yum install epel-release
rpm -Uvh https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
rpm -Uvh https://mirror.webtatic.com/yum/el7/webtatic-release.rpm
vi /etc/php.ini

yum install php70w php70w-cli php70w-gd php70w-mysql php70w-snmp php70w-curl php70w-common php70w-xml httpd net-snmp mariadb ImageMagick jwhois nmap mtr rrdtool MySQL-python net-snmp-utils cronie php70w-mcrypt fping git
```

In `/etc/php.ini` ensure date.timezone is set to your preferred time zone. See http://php.net/manual/en/timezones.php for a list of supported timezones. Valid examples are: "America/New_York", "Australia/Brisbane", "Etc/UTC".

#### Add librenms user
### Configure Apache

```bash
useradd librenms -d /opt/librenms -M -r
usermod -a -G librenms apache
```
vi /etc/httpd/conf.d/librenms.conf

#### Clone repo

```bash
cd /opt
git clone https://github.com/librenms/librenms.git librenms
```

#### Web interface

```bash
cd /opt/librenms
mkdir rrd logs
chmod 775 rrd
vim /etc/httpd/conf.d/librenms.conf
```

Add the following config:
Add the following config, edit `ServerName` as required:

```apache
<VirtualHost *:80>
DocumentRoot /opt/librenms/html/
ServerName librenms.example.com
CustomLog /opt/librenms/logs/access_log combined
ErrorLog /opt/librenms/logs/error_log

AllowEncodedSlashes NoDecode
<Directory "/opt/librenms/html/">
Require all granted
Expand All @@ -90,89 +78,80 @@ Add the following config:
```

> 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 httpd
systemctl restart httpd

#### SELinux

```bash
yum install policycoreutils-python

semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/logs(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/logs(/.*)?'
semanage fcontext -a -t httpd_sys_rw_content_t '/opt/librenms/rrd(/.*)?'
semanage fcontext -a -t httpd_sys_content_t '/opt/librenms/rrd(/.*)?'
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/
setsebool -P httpd_can_sendmail=1
setsebool -P httpd_can_network_connect=1
```

#### Allow access through firewall

```bash
firewall-cmd --zone public --add-service http
firewall-cmd --permanent --zone public --add-service http
```
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

#### Restart Web server
#### Configure snmpd

```bash
systemctl restart httpd
```
cp /opt/librenms/snmpd.conf.example /etc/snmp/snmpd.conf

#### Web installer
vi /etc/snmp/snmpd.conf

Now head to: http://librenms.example.com/install.php and follow the on-screen instructions.
Edit the text which says `RANDOMSTRINGGOESHERE` and set your own community string.

Once you have completed the web installer steps. Please add the following to `config.php`
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

`$config['fping'] = "/usr/sbin/fping";`
### Cron job

#### Configure snmpd
cp /opt/librenms/librenms.nonroot.cron /etc/cron.d/librenms

```bash
cp /opt/librenms/snmpd.conf.example /etc/snmp/snmpd.conf
vim /etc/snmp/snmpd.conf
```
#### Copy logrotate config

Edit the text which says `RANDOMSTRINGGOESHERE` and set your own community string.
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:

```bash
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/misc/librenms.logrotate /etc/logrotate.d/librenms

#### Cron job
### Set permissions

`cp librenms.nonroot.cron /etc/cron.d/librenms`
chown -R librenms:librenms /opt/librenms
setfacl -d -m g::rwx /opt/librenms/rrd /opt/librenms/logs
setfacl -R -m g::rwx /opt/librenms/rrd /opt/librenms/logs

#### Copy logrotate config
## Web installer ##

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:
Now head to the web installer and follow the on-screen instructions.

cp misc/librenms.logrotate /etc/logrotate.d/librenms
http://librenms.example.com/install.php

#### Final steps

```bash
chown -R librenms:librenms /opt/librenms
systemctl enable httpd mariadb
```
### Final steps

Run validate.php as root in the librenms directory:

```bash
cd /opt/librenms
./validate.php
```
cd /opt/librenms
./validate.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 first device

We now suggest that you add localhost as your first device from within the WebUI.

#### What next?
### 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:

Expand All @@ -181,6 +160,8 @@ Now that you've installed LibreNMS, we'd suggest that you have a read of a few o
- [Device Groups](http://docs.librenms.org/Extensions/Device-Groups/)
- [Auto discovery](http://docs.librenms.org/Extensions/Auto-Discovery/)

#### Closing
### 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 [support our Collective](https://t.libren.ms/donations).