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

Update README

Browse Source 
- Add Observium users welcome
- Add contributing guidelines
- Tidy links
This commit is contained in:
Paul Gear
2013-11-04 13:42:39 +10:00
parent ea4777fc0e
commit b1e10c29ac
1 changed files with 28 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@ -18,7 +18,7 @@ Copyright (C) 2013 LibreNMS Contributors <librenms-project@googlegroups.com>
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
Please see LICENSE.txt for usage requirements and restrictions. [LICENSE.txt][14] contains a copy of the full GPLv3 licensing conditions.
Introduction Introduction
@ -30,19 +30,20 @@ systems including Cisco, Linux, FreeBSD, Juniper, Brocade, Foundry, HP and
many more. many more.
LibreNMS is a community-based fork of the last GPL-licensed version of LibreNMS is a community-based fork of the last GPL-licensed version of
Observium <http://observium.org/>. LibreNMS intends to be a viable network [Observium][9]. LibreNMS intends to be a viable network monitoring project
monitoring project and community that: and community that:
- encourages contribution, - encourages contribution,
- focuses on the needs of its users, and - focuses on the needs of its users, and
- offers a welcoming, friendly environment for everyone. - offers a welcoming, friendly environment for everyone.
The Debian Social Contract <http://www.debian.org/social_contract> will be If you're visiting because of a mention on the Observium mailing list,
the basis of our priority system, and mutual respect the basis of our please read our [welcome to Observium users][12].
behaviour towards others.
For more about the culture we're trying to build, please read the Freenode The [Debian Social Contract][10] will be the basis of our priority system,
[guidelines for running an IRC channel][6] and [being a community and mutual respect the basis of our behaviour towards others. For more
catalyst][7]. about the culture we're trying to build, please read the [Freenode
philosophy][13], including [guidelines for running an IRC channel][6] and
[being a community catalyst][7].
Documentation Documentation
@ -54,20 +55,26 @@ For now documentation can be found in the [doc directory][5].
Try It Try It
------ ------
You can try LibreNMS by downloading a VM image. Currently, a Debian-based image is supplied and has been tested with [VMware Fusion 5][8]. You can try LibreNMS by downloading a VM image. Currently, a Debian-based
image is supplied and has been tested with [VMware Fusion 5][8].
Download the VMware Fusion 5 image at ftp://librenms.label-switched.net/pub/librenms_vm.zip, open it, and log in as `root` with the password `root`. Enter the following commands: Download the [VMware Fusion 5 image][11] at open it, and log in as `root`
with the password `root`. Enter the following commands:
cd /opt/librenms cd /opt/librenms
git pull git pull
php discover.php -h all php discover.php -h all
php poller.php -h all php poller.php -h all
You'll then need to find out what the IP of your VM is (`ifconfig | grep add`) and create a DNS entry for `librenms.example.com` to point to that IP. You can also edit your `/etc/hosts` file with the following line: You'll then need to find out the IP of your VM (`ifconfig | grep add`) and
create a DNS entry for `librenms.example.com` to point to that IP. You can
also edit your `/etc/hosts` file with the following line:
$ip librenms.example.com $ip librenms.example.com
where `$ip` is the IP of your VM. From there, just point your web browser to `http://librenms.example.com/` and login with username `librenms` and password `librenms`. where `$ip` is the IP of your VM. From there, just point your web browser
to `http://librenms.example.com/` and login with username `librenms` and
password `librenms`.
Installation Installation
@ -83,6 +90,7 @@ You can participate in the project by:
- Joining the [librenms-project][1] mailing list to post questions and - Joining the [librenms-project][1] mailing list to post questions and
suggestions. suggestions.
- Cloning the [repo][2] and filing bug reports and pull requests on github. - Cloning the [repo][2] and filing bug reports and pull requests on github.
See [CONTRIBUTING][15] for more details.
- Talking to us on [Twitter][3] or [IRC][4]. - Talking to us on [Twitter][3] or [IRC][4].
- Improving the [documentation][5]. - Improving the [documentation][5].
@ -94,5 +102,11 @@ You can participate in the project by:
[6]: http://freenode.net/channel_guidelines.shtml "Freenode channel guidelines" [6]: http://freenode.net/channel_guidelines.shtml "Freenode channel guidelines"
[7]: http://freenode.net/catalysts.shtml "Freenode community catalysts" [7]: http://freenode.net/catalysts.shtml "Freenode community catalysts"
[8]: http://www.vmware.com/products/fusion/ "VMware Fusion" [8]: http://www.vmware.com/products/fusion/ "VMware Fusion"
[9]: http://observium.org/ "Observium web site"
[10]: http://www.debian.org/social_contract "Debian project social contract"
[11]: ftp://librenms.label-switched.net/pub/librenms_vm.zip
[12]: https://github.com/librenms/librenms/tree/master/doc/Observium_Welcome.md
[13]: http://freenode.net/philosophy.shtml "Freenode philosophy"
[14]: https://github.com/librenms/librenms/tree/master/LICENSE.txt
[15]: https://github.com/librenms/librenms/tree/master/doc/CONTRIBUTING.md