This is Munin
=============

Munin the monitoring tool surveys all your computers and remembers what it saw.
It presents all the information in graphs through a web interface.
Its emphasis is on plug and play capabilities.
After completing a installation a high number of monitoring plugins will be
playing with no more effort.

Additional plugins can be easily developed and contributed.
See the `Plugin Gallery <https://gallery.munin-monitoring.org/>`_ for a wide
range of more than a thousand community supported plugins.

Munin is distributed under the `GNU GPL version 2 <https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html>`_.  Munin is copyrighted
2002-2020 by its various authors as identified in the source files.


Resources
=========

* Website: http://munin-monitoring.org/
* Documentation: https://guide.munin-monitoring.org/
* `IRC channel <irc://irc.oftc.net/#munin>`_: ``#munin`` on OFTC
* Mailing List: https://lists.sourceforge.net/lists/listinfo/munin-users
* Plugin Gallery: https://gallery.munin-monitoring.org/
* Live Demo (development): http://demo.munin-monitoring.org/


Note to contributors
--------------------

By sending us patches, you automatically license the code under the same terms
as Munin.

We also might edit your commits metadata (the comment part) for clarifications,
but we'll leave the diff part intact (except for whitespace edits). So in case
there's a problem with the commit diff, we either commit another patch
thereafter or plainly ask you to rework it. We might eventually squash some of
your commits into one.

Please always rebase your pull requests on a released version tag, one of the
stable branches, or the default branch, ``master``.

If you request a pull against ``master``, your pull will be automatically closed
upon merge. If you request against one of the stable release branches, your pull will be
automatically closed upon the next release.

Information on developing Munin with GitHub, such as how branches are used
and the version numbering scheme, can be found in `Munin's GitHub Wiki`__.

.. __ : https://github.com/munin-monitoring/munin/wiki/_pages

Building status
---------------

stable-2.0 : |build-stable2.0|

master : |build-master|  |coverage-master|

docs : |docs-latest|

.. |build-stable2.0| image:: https://travis-ci.org/munin-monitoring/munin.svg?branch=stable-2.0
   :target: https://travis-ci.org/munin-monitoring/munin

.. |build-master| image:: https://github.com/munin-monitoring/munin/actions/workflows/build-n-test.yml/badge.svg?branch=master
   :target: https://github.com/munin-monitoring/munin/actions/workflows/build-n-test.yml

.. |coverage-master| image:: https://coveralls.io/repos/github/munin-monitoring/munin/badge.svg?branch=master
   :target: https://coveralls.io/github/munin-monitoring/munin?branch=master


.. |docs-latest| image:: https://readthedocs.org/projects/munin/badge/?version=latest
   :target: https://guide.munin-monitoring.org/

