2021-03-18 21:28:39 +00:00
|
|
|
[](https://github.com/librenms/librenms/actions/workflows/test.yml?query=event%3Apush+branch%3Amaster)
|
2016-08-08 19:13:33 +00:00
|
|
|
|
2013-10-28 01:34:15 +00:00
|
|
|
Introduction
|
|
|
|
|
------------
|
|
|
|
|
|
2013-10-28 02:00:27 +00:00
|
|
|
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
|
2017-01-26 19:29:23 +00:00
|
|
|
many more.
|
2013-10-28 02:00:27 +00:00
|
|
|
|
2014-10-27 20:53:25 +00:00
|
|
|
We intend LibreNMS to be a viable project and community that:
|
2013-10-28 01:34:15 +00:00
|
|
|
- encourages contribution,
|
|
|
|
|
- focuses on the needs of its users, and
|
|
|
|
|
- offers a welcoming, friendly environment for everyone.
|
|
|
|
|
|
2013-11-04 03:42:39 +00:00
|
|
|
The [Debian Social Contract][10] will be the basis of our priority system,
|
2015-08-21 09:42:39 +00:00
|
|
|
and mutual respect is the basis of our behaviour towards others. For more
|
2013-11-04 03:42:39 +00:00
|
|
|
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].
|
2013-10-30 07:48:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
|
-------------
|
|
|
|
|
|
2015-03-25 20:33:10 +00:00
|
|
|
Documentation can be found in the [doc directory][5] or [docs.librenms.org][16], including instructions
|
2014-10-27 20:53:25 +00:00
|
|
|
for installing and contributing.
|
2014-08-06 17:40:37 +00:00
|
|
|
|
|
|
|
|
|
2014-10-27 20:53:25 +00:00
|
|
|
Participating
|
|
|
|
|
-------------
|
2014-08-06 17:40:37 +00:00
|
|
|
|
|
|
|
|
You can participate in the project by:
|
2020-08-03 11:44:37 +00:00
|
|
|
- Talking to us on [Discord][4] or [Twitter][3].
|
2016-09-16 02:24:04 +00:00
|
|
|
- Joining the [LibreNMS Community](https://community.librenms.org)
|
2014-08-06 17:40:37 +00:00
|
|
|
- Improving the [documentation][5].
|
2019-02-21 12:16:19 +00:00
|
|
|
- Cloning the [repo][2] and filing [pull requests][19] on github.
|
|
|
|
|
- [Bug Reports](https://community.librenms.org) on our Community Fourms
|
|
|
|
|
- See [CONTRIBUTING][15] for more details.
|
2014-08-06 17:40:37 +00:00
|
|
|
|
|
|
|
|
|
2016-01-06 11:05:55 +00:00
|
|
|
VM image
|
|
|
|
|
--------
|
2013-11-03 21:53:53 +00:00
|
|
|
|
2015-03-25 20:33:10 +00:00
|
|
|
You can try LibreNMS by downloading a VM image. Currently, a Ubuntu-based
|
|
|
|
|
image is supplied and has been tested with [VirtualBox][8].
|
2013-11-03 21:53:53 +00:00
|
|
|
|
2019-10-21 00:47:40 +00:00
|
|
|
Download one of the [VirtualBox images][11] we have available, documentation is provided which details
|
2016-09-16 02:24:04 +00:00
|
|
|
login credentials and setup details.
|
2013-11-03 21:53:53 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
License
|
|
|
|
|
-------
|
2013-10-28 01:34:15 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
Copyright (C) 2006-2012 Adam Armstrong <adama@memetic.org>
|
2013-10-30 07:48:36 +00:00
|
|
|
|
2021-04-22 13:27:27 +00:00
|
|
|
Copyright (C) 2013-2021 by individual LibreNMS contributors
|
2014-01-25 03:40:38 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
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.
|
2014-01-25 03:40:38 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
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.
|
2013-10-28 06:31:59 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
You should have received a copy of the GNU General Public License
|
2021-02-08 23:29:04 +00:00
|
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
2013-10-28 06:31:59 +00:00
|
|
|
|
2014-08-06 17:40:37 +00:00
|
|
|
[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).
|
|
|
|
|
|
2015-05-18 11:00:40 +00:00
|
|
|
Please see [Acknowledgements][17]
|
2013-10-28 06:31:59 +00:00
|
|
|
|
2013-10-30 07:48:36 +00:00
|
|
|
[2]: https://github.com/librenms/librenms "Main LibreNMS GitHub repo"
|
|
|
|
|
[3]: https://twitter.com/librenms "@LibreNMS on Twitter"
|
2020-08-03 11:44:37 +00:00
|
|
|
[4]: https://discord.gg/librenms "Discord LibreNMS Server"
|
2013-10-30 07:48:36 +00:00
|
|
|
[5]: https://github.com/librenms/librenms/tree/master/doc/
|
2016-11-04 07:09:02 +00:00
|
|
|
[6]: http://freenode.net/changuide "Freenode channel guidelines"
|
|
|
|
|
[7]: http://freenode.net/catalysts "Freenode community catalysts"
|
2015-03-25 20:33:10 +00:00
|
|
|
[8]: https://www.virtualbox.org/ "VirtualBox"
|
2013-11-04 03:42:39 +00:00
|
|
|
[10]: http://www.debian.org/social_contract "Debian project social contract"
|
2021-02-08 23:29:04 +00:00
|
|
|
[11]: https://www.librenms.org/#downloads
|
2013-11-04 03:42:39 +00:00
|
|
|
[13]: http://freenode.net/philosophy.shtml "Freenode philosophy"
|
|
|
|
|
[14]: https://github.com/librenms/librenms/tree/master/LICENSE.txt
|
2020-11-27 22:34:58 +00:00
|
|
|
[15]: https://docs.librenms.org/General/Contributing/
|
|
|
|
|
[16]: https://docs.librenms.org/
|
|
|
|
|
[17]: https://docs.librenms.org/General/Acknowledgement/
|
2016-01-06 11:05:55 +00:00
|
|
|
[19]: https://github.com/librenms/librenms/pulls
|
2017-06-06 21:44:21 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Backers
|
|
|
|
|
|
|
|
|
|
Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/librenms#backer)]
|
|
|
|
|
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/0/website" target="_blank"><img src="https://opencollective.com/librenms/backer/0/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/1/website" target="_blank"><img src="https://opencollective.com/librenms/backer/1/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/2/website" target="_blank"><img src="https://opencollective.com/librenms/backer/2/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/3/website" target="_blank"><img src="https://opencollective.com/librenms/backer/3/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/4/website" target="_blank"><img src="https://opencollective.com/librenms/backer/4/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/5/website" target="_blank"><img src="https://opencollective.com/librenms/backer/5/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/6/website" target="_blank"><img src="https://opencollective.com/librenms/backer/6/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/7/website" target="_blank"><img src="https://opencollective.com/librenms/backer/7/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/8/website" target="_blank"><img src="https://opencollective.com/librenms/backer/8/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/9/website" target="_blank"><img src="https://opencollective.com/librenms/backer/9/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/10/website" target="_blank"><img src="https://opencollective.com/librenms/backer/10/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/11/website" target="_blank"><img src="https://opencollective.com/librenms/backer/11/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/12/website" target="_blank"><img src="https://opencollective.com/librenms/backer/12/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/13/website" target="_blank"><img src="https://opencollective.com/librenms/backer/13/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/14/website" target="_blank"><img src="https://opencollective.com/librenms/backer/14/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/15/website" target="_blank"><img src="https://opencollective.com/librenms/backer/15/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/16/website" target="_blank"><img src="https://opencollective.com/librenms/backer/16/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/17/website" target="_blank"><img src="https://opencollective.com/librenms/backer/17/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/18/website" target="_blank"><img src="https://opencollective.com/librenms/backer/18/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/19/website" target="_blank"><img src="https://opencollective.com/librenms/backer/19/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/20/website" target="_blank"><img src="https://opencollective.com/librenms/backer/20/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/21/website" target="_blank"><img src="https://opencollective.com/librenms/backer/21/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/22/website" target="_blank"><img src="https://opencollective.com/librenms/backer/22/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/23/website" target="_blank"><img src="https://opencollective.com/librenms/backer/23/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/24/website" target="_blank"><img src="https://opencollective.com/librenms/backer/24/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/25/website" target="_blank"><img src="https://opencollective.com/librenms/backer/25/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/26/website" target="_blank"><img src="https://opencollective.com/librenms/backer/26/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/27/website" target="_blank"><img src="https://opencollective.com/librenms/backer/27/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/28/website" target="_blank"><img src="https://opencollective.com/librenms/backer/28/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/backer/29/website" target="_blank"><img src="https://opencollective.com/librenms/backer/29/avatar.svg"></a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Sponsors
|
|
|
|
|
|
2021-04-22 19:34:03 +00:00
|
|
|
Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/librenms#sponsor)]
|
2017-06-06 21:44:21 +00:00
|
|
|
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/0/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/0/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/1/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/1/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/2/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/2/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/3/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/3/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/4/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/4/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/5/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/5/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/6/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/6/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/7/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/7/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/8/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/8/avatar.svg"></a>
|
|
|
|
|
<a href="https://opencollective.com/librenms/sponsor/9/website" target="_blank"><img src="https://opencollective.com/librenms/sponsor/9/avatar.svg"></a>
|
|
|
|
|
|
|
|
|
|
|
