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
   3 # Icinga 2
   4
   5 ![Icinga Logo](https://www.icinga.com/wp-content/uploads/2014/06/icinga_logo.png)
   6
   7 #### Table of Contents
   8
   9 1. [About][About]
  10 2. [License][License]
  11 3. [Installation][Installation]
  12 4. [Documentation][Documentation]
  13 5. [Support][Support]
  14 6. [Contributing][Contributing]
  15
  16 ## About
  17
  18 Icinga 2 is an open source monitoring system which checks the availability of your
  19 network resources, notifies users of outages, and generates performance data for reporting.
  20
  21 Scalable and extensible, Icinga 2 can monitor large, complex environments across
  22 multiple locations.
  23
  24 Icinga 2 as monitoring core works best with [Icinga Web 2](https://www.icinga.com/products/icinga-web-2/)
  25 as web interface.
  26
  27 More information can be found at [www.icinga.com](https://www.icinga.com/products/icinga-2/)
  28 and inside the [documentation](https://www.icinga.com/docs/icinga2/latest/).
  29
  30 ## Licensing
  31
  32 Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
  33 General Public License Version 2, you will find a copy of this license in the
  34 COPYING file included in the source package.
  35
  36 In addition, as a special exception, the copyright holders give
  37 permission to link the code of portions of this program with the
  38 OpenSSL library under certain conditions as described in each
  39 individual source file, and distribute linked combinations including
  40 the two.
  41
  42 You must obey the GNU General Public License in all respects for all
  43 of the code used other than OpenSSL. If you modify file(s) with this
  44 exception, you may extend this exception to your version of the
  45 file(s), but you are not obligated to do so. If you do not wish to do
  46 so, delete this exception statement from your version. If you delete
  47 this exception statement from all source files in the program, then
  48 also delete it here.
  49
  50 ## Installation
  51
  52 Read the [INSTALL.md](INSTALL.md) file for more information about how to install it.
  53
  54 ## Documentation
  55
  56 The documentation is located in the [doc/](doc/) directory. The latest documentation
  57 is also available on https://docs.icinga.com
  58
  59 ## Support
  60
  61 Check the project website at https://www.icinga.com for status updates. Join the
  62 [community channels](https://www.icinga.com/community) for questions
  63 or ask an Icinga partner for [professional support](https://www.icinga.com/services/support/).
  64
  65 ## Contributing
  66
  67 There are many ways to contribute to Icinga -- whether it be sending patches,
  68 testing, reporting bugs, or reviewing and updating the documentation. Every
  69 contribution is appreciated!
  70
  71 Please continue reading in the [contributing chapter](CONTRIBUTING.md).
  72
  73 <!-- TOC URLs -->
  74 [About]: #about
  75 [License]: #license
  76 [Installation]: #installation
  77 [Documentation]: #documentation
  78 [Support]: #support
  79 [Contributing]: #contributing