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 2](https://icinga.com/products/icinga-2/) 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 2 can monitor large, complex environments across
  24 multiple locations.
  25
  26 Icinga 2 as core requires [Icinga Web 2](https://icinga.com/products/icinga-web-2/)
  27 on top in your Icinga Stack.
  28
  29 ![Icinga Dashboard](https://icinga.com/wp-content/uploads/2017/12/icingaweb2-2.5.0-dashboard.png)
  30
  31 ## Installation
  32
  33 For installing Icinga please check the [installation chapter](https://icinga.com/docs/icinga2/latest/doc/02-getting-started/)
  34 in the documentation.
  35
  36 If you are a packager, please read the [development chapter](https://icinga.com/docs/icinga2/latest/doc/21-development/)
  37 for more details.
  38
  39 ## Documentation
  40
  41 The documentation is available on [icinga.com/docs](https://icinga.com/docs/icinga2/latest/).
  42
  43 ## Support
  44
  45 Check the [project website](https://icinga.com) for status updates. Join the
  46 [community channels](https://icinga.com/community/) for questions
  47 or ask an Icinga partner for [professional support](https://icinga.com/support/).
  48
  49 ## License
  50
  51 Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
  52 General Public License Version 2, you will find a copy of this license in the
  53 COPYING file included in the source package.
  54
  55 In addition, as a special exception, the copyright holders give
  56 permission to link the code of portions of this program with the
  57 OpenSSL library under certain conditions as described in each
  58 individual source file, and distribute linked combinations including
  59 the two.
  60
  61 You must obey the GNU General Public License in all respects for all
  62 of the code used other than OpenSSL. If you modify file(s) with this
  63 exception, you may extend this exception to your version of the
  64 file(s), but you are not obligated to do so. If you do not wish to do
  65 so, delete this exception statement from your version. If you delete
  66 this exception statement from all source files in the program, then
  67 also delete it here.
  68
  69 ## Contributing
  70
  71 There are many ways to contribute to Icinga -- whether it be sending patches,
  72 testing, reporting bugs, or reviewing and updating the documentation. Every
  73 contribution is appreciated!
  74
  75 Please continue reading in the [contributing chapter](CONTRIBUTING.md).
  76
  77 ### Security Issues
  78
  79 For reporting security issues please visit [this page](https://icinga.com/contact/security/).
  80
  81 <!-- TOC URLs -->
  82 [About]: #about
  83 [License]: #license
  84 [Installation]: #installation
  85 [Documentation]: #documentation
  86 [Support]: #support
  87 [Contributing]: #contributing