granicus.if.org Git - icinga2/blob - README.md

   1 [![Build Status](https://travis-ci.org/Icinga/icinga2.svg?branch=master)](https://travis-ci.org/Icinga/icinga2)
   2 [![Github Tag](https://img.shields.io/github/tag/Icinga/icinga2.svg)](https://github.com/Icinga/icinga2)
   3
   4 # Icinga 2
   5
   6 ![Icinga Logo](https://icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
   7
   8 #### Table of Contents
   9
  10 1. [About][About]
  11 2. [Installation][Installation]
  12 3. [Documentation][Documentation]
  13 4. [Support][Support]
  14 5. [License][License]
  15 6. [Contributing][Contributing]
  16
  17 ## About
  18
  19 [Icinga](https://icinga.com/products/) is a monitoring system which checks
  20 the availability of your network resources, notifies users of outages, and generates
  21 performance data for reporting.
  22
  23 Scalable and extensible, Icinga can monitor large, complex environments across
  24 multiple locations.
  25
  26 Icinga 2 is the monitoring server and requires [Icinga Web 2](https://icinga.com/products/)
  27 on top in your Icinga Stack. The [configuration](https://icinga.com/products/configuration/)
  28 can be easily managed with either the [Icinga Director](https://icinga.com/docs/director/latest/),
  29 config management tools or plain text within the [Icinga DSL](https://icinga.com/docs/icinga2/latest/doc/17-language-reference/).
  30
  31 ![Icinga Dashboard](https://icinga.com/wp-content/uploads/2017/12/icingaweb2-2.5.0-dashboard.png)
  32
  33 ## Installation
  34
  35 * [Installation](https://icinga.com/docs/icinga2/latest/doc/02-installation/)
  36 * [Monitoring Basics](https://icinga.com/docs/icinga2/latest/doc/03-monitoring-basics/)
  37 * [Configuration](https://icinga.com/docs/icinga2/latest/doc/04-configuration/)
  38 * [Distributed Monitoring](https://icinga.com/docs/icinga2/latest/doc/06-distributed-monitoring/)
  39 * [Addons, Integrations and Features](https://icinga.com/docs/icinga2/latest/doc/13-addons/)
  40 * [Troubleshooting](https://icinga.com/docs/icinga2/latest/doc/15-troubleshooting/)
  41 * [Upgrading](https://icinga.com/docs/icinga2/latest/doc/16-upgrading-icinga-2/)
  42
  43 Once Icinga Server and Web are running in your distributed environment,
  44 make sure to check out the many [Icinga modules](https://icinga.com/docs/)
  45 for even better monitoring.
  46
  47 ## Documentation
  48
  49 The documentation is available on [icinga.com/docs](https://icinga.com/docs/icinga2/latest/).
  50
  51 ## Support
  52
  53 Check the [project website](https://icinga.com) for status updates. Join the
  54 [community channels](https://icinga.com/community/) for questions
  55 or ask an Icinga partner for [professional support](https://icinga.com/support/).
  56
  57 ## License
  58
  59 Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
  60 General Public License Version 2, you will find a copy of this license in the
  61 COPYING file included in the source package.
  62
  63 In addition, as a special exception, the copyright holders give
  64 permission to link the code of portions of this program with the
  65 OpenSSL library under certain conditions as described in each
  66 individual source file, and distribute linked combinations including
  67 the two.
  68
  69 You must obey the GNU General Public License in all respects for all
  70 of the code used other than OpenSSL. If you modify file(s) with this
  71 exception, you may extend this exception to your version of the
  72 file(s), but you are not obligated to do so. If you do not wish to do
  73 so, delete this exception statement from your version. If you delete
  74 this exception statement from all source files in the program, then
  75 also delete it here.
  76
  77 ## Contributing
  78
  79 There are many ways to contribute to Icinga -- whether it be sending patches,
  80 testing, reporting bugs, or reviewing and updating the documentation. Every
  81 contribution is appreciated!
  82
  83 Please continue reading in the [contributing chapter](CONTRIBUTING.md).
  84
  85 If you are a packager, please read the [development chapter](https://icinga.com/docs/icinga2/latest/doc/21-development/)
  86 for more details.
  87
  88 ### Security Issues
  89
  90 For reporting security issues please visit [this page](https://icinga.com/contact/security/).
  91
  92 <!-- TOC URLs -->
  93 [About]: #about
  94 [License]: #license
  95 [Installation]: #installation
  96 [Documentation]: #documentation
  97 [Support]: #support
  98 [Contributing]: #contributing