doc: Clean whitespaces in documentation

This commit is contained in:
Sebastien Badia
2014-11-28 01:25:45 +01:00
parent c4c419a706
commit 7a070e2a9f
8 changed files with 19 additions and 22 deletions

View File

@ -5,10 +5,10 @@ LibreNMS is a fork of [Observium][1]. Observium was written by:
Contributors to LibreNMS:
- Paul Gear <github@libertysys.com.au> (paulgear)
- Neil Lathwood <neil@lathwood.co.uk> (laf)
- Daniel Preussker <f0o@devilcode.org> (f0o)
- Neil Lathwood <neil@lathwood.co.uk> (laf)
- Daniel Preussker <f0o@devilcode.org> (f0o)
- Bohdan Sanders <git@bohdans.com> (bohdan-s)
- Toni Cunyat <elbuit@gmail.com> (elbuit)
[1]: http://observium.org/ "Observium web site"

View File

@ -41,18 +41,18 @@ This host is where the web server and SNMP poller run. It could be the same mac
Install the required software:
apt-get install libapache2-mod-php5 php5-cli php5-mysql php5-gd php5-snmp php-pear snmp graphviz php5-mcrypt php5-json apache2 fping imagemagick whois mtr-tiny nmap python-mysqldb snmpd mysql-client php-net-ipv4 php-net-ipv6 rrdtool git
The packages listed above are an all-inclusive list of packages that were necessary on a clean install of Ubuntu 12.04/14.04.
You need to configure snmpd appropriately if you have not already done so. An absolute minimal config for snmpd is:
rocommunity public 127.0.0.1
Adding the above line to `/etc/snmp/snmpd.conf` and running `service snmpd restart` will activate this config.
In `/etc/php5/apache2/php.ini` and `/etc/php5/cli/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".
### Cloning ###
LibreNMS is installed using git. If you're not familiar with git, check out the [git book][2] or the tips at [git ready][3]. The initial install from github.com is called a `git clone`; subsequent updates are done through `git pull`.
@ -62,7 +62,7 @@ You can clone the repository via HTTPS or SSH. In either case, you need to ensu
cd /opt
git clone https://github.com/librenms/librenms.git librenms
cd /opt/librenms
The recommended method of cloning a git repository is HTTPS. If you would like to clone via SSH instead, use the command `git clone git@github.com:librenms/librenms.git librenms` instead.
Sometimes the initial clone can take quite a while (nearly 3 minutes on a 10 Mbps fibre connection in Australia is a recent example). If it's a big problem to you, you can save about 50% of the bandwidth by not pulling down the full git history. This comes with some limitations (namely that you can't use it as the basis for further git repos), but if you're not planning to develop for LibreNMS it's an acceptable option. To perform the initial clone without full history, run the following instead:
@ -112,7 +112,7 @@ Change `librenms.example.com` to the appropriate hostname for your domain, then
a2ensite librenms.conf
a2enmod rewrite
service apache2 restart
(To get to your LibreNMS install externally, you'll also need add it to your DNS or hosts file.)
### Manual vs. web installer ###
@ -121,7 +121,7 @@ At this stage you can either launch the web installer by going to http://librenm
cp config.php.default config.php
vim config.php
Change the values to the right of the equal sign for lines beginning with `$config[db_]` to match your database information as setup above.
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.

View File

@ -36,7 +36,7 @@ Change `127.0.0.1` to the IP address that your MySQL server should listen on. R
Install necessary software. The packages listed below are an all-inclusive list of packages that were necessary on a clean install of Debian 7.
apt-get install lighttpd php5-cli php5-mysql php5-gd php5-snmp php5-cgi php-pear snmp graphviz mysql-server mysql-client rrdtool sendmail fping imagemagick whois mtr-tiny nmap ipmitool php5-mcrypt php5-json python-mysqldb snmpd php-net-ipv4 php-net-ipv6 rrdtool git
### Cloning ###
You can clone the repository via HTTPS or SSH. In either case, you need to ensure the appropriate port (443 for HTTPS, 22 for SSH) is open in the outbound direction for your server.
@ -49,7 +49,7 @@ At this stage you can either launch the web installer by going to http://IP/inst
cp config.php.default config.php
vim config.php
> NOTE: The recommended method of cloning a git repository is HTTPS. If you would like to clone via SSH instead, use the command `git clone git@github.com:librenms/librenms.git librenms` instead.
Change the values to the right of the equal sign for lines beginning with `$config[db_]` to match your database information as setup above.
@ -111,7 +111,7 @@ Enable fastcgi in Lighttpd by running the following commands,
And add the following to /etc/php5/cgi/php.ini
cgi.fix_pathinfo = 1
then restart Lighttpd:
service lighttpd restart
@ -145,6 +145,3 @@ LibreNMS performs daily updates by default. At 00:15 system time every day, a `
so that it looks like this:
$config['update'] = 0;

View File

@ -41,7 +41,7 @@ Function( (Type) $Variable [= Default] [,...] ) | Returns | Description
### <a name="glob.attr">Attributes</a>
Attribute | Type | Description
--- | --- | ---
--- | --- | ---
`$params` | `String` | Contains all arguments that are passed to the `.command`.
`$this->chan` | `Array` | Channels that are configured.
`$this->commands` | `Array` | Contains accessible `commands`.
@ -77,4 +77,4 @@ Attribute | Type | Description
...
$config['irc_external'][] = "join-ng";
...
```
```

View File

@ -127,4 +127,4 @@ File: includes/ircbot/echo.inc.php
} else {
return $this->respond("root shouldn't be online so late!");
}
```
```

View File

@ -10,7 +10,7 @@ Table of Content:
# <a name="about">About</a>:
Librenms can interpret, display and group certain additional information on ports.
For this a small `bash` script is supplied in `librenms/scripts` called `ifAlias`.
For this a small `bash` script is supplied in `librenms/scripts` called `ifAlias`.
<a name="setup">Setup</a>:
@ -52,4 +52,4 @@ See [examples](#examples) for formats.
# <a name="source">Sourcecode</a>:
* https://github.com/librenms/librenms/blob/master/scripts/ifAlias
* https://github.com/librenms/librenms/blob/master/scripts/ifAlias

View File

@ -65,7 +65,7 @@ Reasons why you might want to use LibreNMS instead of Observium:
"Free Software Foundation - what is free software?"
[7]: http://libertysys.com.au/blog/observium-and-gpl
"Paul's blog on what the GPL offers users"
[8]: https://github.com/librenms/librenms/blob/master/doc/CONTRIBUTING.md
[8]: https://github.com/librenms/librenms/blob/master/doc/CONTRIBUTING.md
"Contribution guidelines"
[9]: https://github.com/librenms/librenms/issues
"LibreNMS issue database at GitHub"

View File

@ -7,7 +7,7 @@ Roadmap
obviously not be as customised as the specifically supported devices
but should still be useful to users.
- Ruckus wireless controllers
- Functionality/performance improvements:
- Eliminate interface churn for transient interfaces (e.g. ppp/tun)
on net-snmp.