mirror of
https://github.com/stylersnico/librenms.git
synced 2026-07-27 08:02:51 +02:00
e750af7 Update README.md 805bcc3 Update CONTRIBUTING.md 613a583 Update CONTRIBUTING.md 31e50cc Update bootstrap-datetimepicker-build.less d004434 Merge pull request #891 from Eonasdan/development adc8a68 fixes #867 8e16324 fixing locale formatting dfe5657 patch #752 b2a71de fixes #874 d00e39d version bump 762a90d couple of fixes d072d92 added keepInvalid 8eae1a4 Fixes and some new features 7f7dff4 Merge pull request #802 from zpaulovics/development 28699b6 Merge pull request #818 from mcarepa/improv-picker-placement 0abdcb1 Merge pull request #828 from ahmader/development a9744c5 Merge pull request #831 from admackin/development 86b49cb Update package.json ea501fa Fixes #793 0c5ad39 quick typo fixs 1cff47b picker placement conditions updated 6d245c9 version bump a4e7201 fixes and new features a865edf Revert "flipping events again" 78e28f5 Revert "tests" b7ae1e3 Fixed the options handling for componets 197647d tests 8d0fef8 flipping events again 8daa2b2 fix for #794 0221cb4 Merge pull request #778 from davidrojo/iss777 c11f3be Merge pull request #789 from comerc/patch-5 159d29e Update bootstrap-datetimepicker.js b545f2a Fixed coding style 19b485a Fixed coding style 6066555 Update CONTRIBUTING.md 1b2fe6e Update CONTRIBUTING.md 8d5b40a Fixes #777 37d8ce1 fix for #760 1cae292 fix for #761 499f619 fixing less 557b657 updating to v4 d9560b3 Update CONTRIBUTING.md 29b397d Update README.md 29cd87f Update bower.json fc56ea1 fixes #664 4c74e82 Merge pull request #635 from PeterDaveHello/patch-1 d756797 fix indent in package.json git-subtree-dir: html/js/datetime git-subtree-split: e750af7a4a65870030056a83fd1b52fc7b343246
129 lines
4.8 KiB
Markdown
129 lines
4.8 KiB
Markdown
Introduction
|
|
------------
|
|
|
|
LibreNMS is an autodiscovering PHP/MySQL/SNMP based network monitoring
|
|
which includes support for a wide range of network hardware and operating
|
|
systems including Cisco, Linux, FreeBSD, Juniper, Brocade, Foundry, HP and
|
|
many more. LibreNMS is a community-based fork of [Observium][9].
|
|
|
|
We intend LibreNMS to be a viable project and community that:
|
|
- encourages contribution,
|
|
- focuses on the needs of its users, and
|
|
- offers a welcoming, friendly environment for everyone.
|
|
|
|
The [Debian Social Contract][10] will be the basis of our priority system,
|
|
and mutual respect the basis of our behaviour towards others. For more
|
|
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 can be found in the [doc directory][5] or [docs.librenms.org][16], including instructions
|
|
for installing and contributing.
|
|
|
|
|
|
Participating
|
|
-------------
|
|
|
|
You can participate in the project by:
|
|
- Joining the [librenms-project][1] mailing list to post questions and
|
|
suggestions.
|
|
- Talking to us on [Twitter][3] or [IRC][4].
|
|
- Improving the [documentation][5].
|
|
- Cloning the [repo][2] and filing bug reports and pull requests on github.
|
|
See [CONTRIBUTING][15] for more details.
|
|
|
|
|
|
Try It
|
|
------
|
|
|
|
You can try LibreNMS by downloading a VM image. Currently, a Ubuntu-based
|
|
image is supplied and has been tested with [VirtualBox][8].
|
|
|
|
Download the [VirtualBox / VMWare image][11] and open it then log in with credentials provided.
|
|
Enter the following commands:
|
|
|
|
cd /opt/librenms
|
|
git pull
|
|
php discover.php -h all
|
|
php poller.php -h all
|
|
|
|
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
|
|
|
|
where `$ip` is the IP of your VM.
|
|
|
|
Add a new user by entering:
|
|
|
|
./adduser.php <username> <password> 10 <email>
|
|
|
|
replace <username>, <password> and <email> with a username, password and your email address.
|
|
|
|
From there, just point your web browser
|
|
to `http://librenms.example.com/` and login with your new username and password.
|
|
|
|
|
|
License
|
|
-------
|
|
|
|
Copyright (C) 2006-2012 Adam Armstrong <adama@memetic.org>
|
|
|
|
Copyright (C) 2013-2014 by individual LibreNMS contributors
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
[LICENSE.txt][14] contains a copy of the full GPLv3 licensing conditions.
|
|
|
|
The following additional license conditions apply to LibreNMS (a GPL
|
|
exception):
|
|
|
|
As a special exception, you have permission to link or otherwise combine
|
|
LibreNMS with the included copies of the following third-party software,
|
|
and distribute modified versions, as long as you follow the requirements
|
|
of the GNU GPL v3 in regard to all of the remaining software (comprising
|
|
LibreNMS).
|
|
|
|
The authorised third-party software packages under this exception are as
|
|
follows (their title, location, and license are noted where known):
|
|
- JpGraph (html/includes/jpgraph): QPL 1.0 license
|
|
- MIBS (mibs): unknown/various
|
|
- html/graph-realtime.php: BSD (original?)
|
|
- html/includes/collectd/: GPLv2 only
|
|
- overLIB (html/js/overlib_mini.js): modified Artistic 1.0?
|
|
- scripts/*/mysql: GPLv2 only
|
|
- check_mk (scripts/check_mk*): GPLv2
|
|
|
|
[1]: https://groups.google.com/forum/#!forum/librenms-project "LibreNMS"
|
|
[2]: https://github.com/librenms/librenms "Main LibreNMS GitHub repo"
|
|
[3]: https://twitter.com/librenms "@LibreNMS on Twitter"
|
|
[4]: irc://irc.freenode.net/##librenms "LibreNMS IRC channel"
|
|
[5]: https://github.com/librenms/librenms/tree/master/doc/
|
|
[6]: http://freenode.net/channel_guidelines.shtml "Freenode channel guidelines"
|
|
[7]: http://freenode.net/catalysts.shtml "Freenode community catalysts"
|
|
[8]: https://www.virtualbox.org/ "VirtualBox"
|
|
[9]: http://observium.org/ "Observium web site"
|
|
[10]: http://www.debian.org/social_contract "Debian project social contract"
|
|
[11]: http://www.librenms.org/#downloads
|
|
[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]: http://docs.librenms.org/General/Contributing/
|
|
[16]: http://docs.librenms.org/
|