Merge pull request #766 from laf/docs

Updated install docs to have more headings

doc/Installation/Installation-(Debian-Ubuntu).md

@@ -3,7 +3,7 @@
 
 > 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`.
 
-## On the database server ##
+### On the DB Server ###
 
 This host is where the MySQL database runs.  It could be the same machine as your network management server (this is the most common initial deployment scenario).
 
@@ -36,7 +36,7 @@ Change `127.0.0.1` to the IP address that your MySQL server should listen on.  R
 
     service mysql restart
 
-## On the network management server ##
+### On the NMS ###
 
 This host is where the web server and SNMP poller run.  It could be the same machine as your database server.
 
@@ -134,10 +134,14 @@ Change the values to the right of the equal sign for lines beginning with `$conf
 
 Change the value of `$config['snmp']['community']` from `public` to whatever your read-only SNMP community is.  If you have multiple communities, set it to the most common.
 
+### Initialise the database ###
+
 Initiate the follow database with the following command:
 
     php build-base.php
 
+### Create admin user ###
+
 Create the admin user - priv should be 10
 
     php adduser.php <name> <pass> 10
@@ -154,6 +158,8 @@ Discover localhost and poll it for the first time:
 
     php discovery.php -h all && php poller.php -h all
 
+### Create cronjob ###
+
 LibreNMS uses Job Snijders' [poller-wrapper.py][1].  By default, the cron job runs `poller-wrapper.py` with 16 threads.  The current recommendation is to use 4 threads per core as a rule of thumb.  If the thread count needs to be changed, you can do so by editing the cron file (`/etc/cron.d/librenms`).  Just add a number after `poller-wrapper.py`, as in the example below:
 
     /opt/librenms/poller-wrapper.py 12 >> /dev/null 2>&1

doc/Installation/Installation-(RHEL-CentOS).md

@@ -2,7 +2,7 @@ NOTE: What follows is a very rough list of commands.  This works on a fresh inst
 
 NOTE: These instructions assume you are the root user.  If you are not, prepend `sudo` to all shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s`.
 
-## On the DB Server ##
+### On the DB Server ###
 
     yum install net-snmp mysql-server
     service snmpd start
@@ -40,7 +40,7 @@ Change `<ip>` to the IP address that your MySQL server should listen on.  Restar
 
     service mysqld restart
 
-## On the NMS ##
+### On the NMS ###
 
 Install necessary software.  The packages listed below are an all-inclusive list of packages that were necessary on a clean install of CentOS 6.4.  It also requires the EPEL repository.
 
@@ -143,10 +143,14 @@ Add the following line to the end of `config.php`:
 
     $config['fping'] = "/usr/sbin/fping";
 
+### Initialise the database ###
+
 Initiate the follow database with the following command:
 
     php build-base.php
 
+### Create admin user ###
+
 Create the admin user - priv should be 10
 
     php adduser.php <name> <pass> 10
@@ -182,6 +186,8 @@ Discover localhost and poll it for the first time:
 
     php discovery.php -h all && php poller.php -h all
 
+### Create cronjob ###
+
 The polling method used by LibreNMS is `poller-wrapper.py`, which was placed in
 the public domain by its author.  By default, the LibreNMS cronjob runs `poller-
 wrapper.py` with 16 threads.  The current LibreNMS recommendation is to use 4 th
@@ -206,3 +212,7 @@ ing your `config.php` file.  Remove the comment (the `#` mark) on the line:
 so that it looks like this:
 
     $config['update'] = 0;
+
+### Install complete ###
+
+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.

doc/Installation/Installation-Lighttpd-(Debian-Ubuntu).md

@@ -2,7 +2,7 @@
 
 > NOTE: These instructions assume you are the root user.  If you are not, prepend `sudo` to all shell commands (the ones that aren't at `mysql>` prompts) or temporarily become a user with root privileges with `sudo -s`.
 
-## On the DB Server ##
+### On the DB Server ###
 
     apt-get install mysql-server mysql-client snmpd
     mysql -uroot -p
@@ -33,7 +33,7 @@ Change `127.0.0.1` to the IP address that your MySQL server should listen on.  R
 
     service mysql restart
 
-## On the NMS ##
+### On the NMS ###
 
 Install necessary software.  The packages listed below are an all-inclusive list of packages that were necessary on a clean install of Debian 7.
 
@@ -58,10 +58,14 @@ Change the values to the right of the equal sign for lines beginning with `$conf
 
 Change the value of `$config['snmp']['community']` from `public` to whatever your read-only SNMP community is.  If you have multiple communities, set it to the most common.
 
+### Initialise the database ###
+
 Initiate the follow database with the following command:
 
     php build-base.php
 
+### Create admin user ###
+
 Create the admin user - priv should be 10
 
     php adduser.php <name> <pass> 10
@@ -128,6 +132,8 @@ Discover localhost and poll it for the first time:
 
     php discovery.php -h all && php poller.php -h all
 
+### Create cronjob ###
+
 The polling method used by LibreNMS is `poller-wrapper.py`, which was placed in the public domain by its author.  By default, the LibreNMS cronjob runs `poller-wrapper.py` with 16 threads.  The current LibreNMS recommendation is to use 4 threads per core.  The default if no thread count is `16 threads`.
 
 If the thread count needs to be changed, you can do so by editing the cron file (`/etc/cron.d/librenms`).
@@ -148,3 +154,7 @@ LibreNMS performs daily updates by default.  At 00:15 system time every day, a `
 so that it looks like this:
 
     $config['update'] = 0;
+
+### Install complete ###
+
+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.