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. [Development and Contributions][Development]
  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](doc/1-about.md).
  29
  30 ## License
  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 ## Installation
  37
  38 Read the [INSTALL.md](INSTALL.md) file for more information about how to install it.
  39
  40 ## Documentation
  41
  42 The documentation is located in the [doc/](doc/) directory. The latest documentation
  43 is also available on https://docs.icinga.com
  44
  45 ## Support
  46
  47 Check the project website at https://www.icinga.com for status updates. Join the
  48 [community channels](https://www.icinga.com/community/get-involved/) for questions
  49 or ask an Icinga partner for [professional support](https://www.icinga.com/services/support/).
  50
  51 ## Development
  52
  53 The Git repository is located on [GitHub](https://github.com/Icinga/icinga2).
  54
  55 Icinga 2 is written in C++ and can be built on Linux/Unix and Windows.
  56 Read more about development builds in the [INSTALL.md](INSTALL.md) file.
  57
  58 ### Contributing
  59
  60 There are many ways to contribute to Icinga -- whether it be sending patches,
  61 testing, reporting bugs, or reviewing and updating the documentation. Every
  62 contribution is appreciated!
  63
  64 Please read the [contributing section](https://www.icinga.com/community/get-involved/)
  65 first. Then you should have a look at the [roadmap](https://github.com/Icinga/icinga2/milestones)
  66 and remaining [open issues](https://github.com/Icinga/icinga2/issues).
  67
  68 Pick issues you want to help resolve, fork the [repository on GitHub](https://github.com/Icinga/icinga2)
  69 and send a pull request with your changes. Thanks for your contribution!
  70
  71 ### Testing
  72
  73 Basic unit test coverage is provided by running `make test` during package builds.
  74 Read the [INSTALL.md](INSTALL.md) file for more information about development builds.
  75
  76 Snapshot packages from the laster development branch are available inside the
  77 [package repository](http://packages.icinga.com).
  78
  79 You can help test-drive the latest Icinga 2 snapshot packages inside the
  80 [Icinga 2 Vagrant boxes](https://github.com/icinga/icinga-vagrant).
  81
  82
  83 [About]: #about
  84 [License]: #license
  85 [Installation]: #installation
  86 [Documentation]: #documentation
  87 [Support]: #support
  88 [Development]: #development