2017-01-12 13:56:49 +01:00
|
|
|
[](https://travis-ci.org/Icinga/icinga2)
|
|
|
|
|
|
2014-06-13 15:24:03 +02:00
|
|
|
# Icinga 2
|
2012-05-25 16:56:47 +02:00
|
|
|
|
2017-01-10 15:54:22 +01:00
|
|
|
|
2016-12-08 17:38:41 +01:00
|
|
|
|
|
|
|
|
#### Table of Contents
|
|
|
|
|
|
2016-12-08 18:30:49 +01:00
|
|
|
1. [About][About]
|
|
|
|
|
2. [License][License]
|
|
|
|
|
3. [Installation][Installation]
|
|
|
|
|
4. [Documentation][Documentation]
|
|
|
|
|
5. [Support][Support]
|
|
|
|
|
6. [Development and Contributions][Development]
|
2016-12-08 17:38:41 +01:00
|
|
|
|
2014-06-13 15:24:03 +02:00
|
|
|
## About
|
|
|
|
|
|
|
|
|
|
Icinga 2 is an open source monitoring system which checks the availability of your
|
|
|
|
|
network resources, notifies users of outages, and generates performance data for reporting.
|
|
|
|
|
|
|
|
|
|
Scalable and extensible, Icinga 2 can monitor large, complex environments across
|
|
|
|
|
multiple locations.
|
|
|
|
|
|
2016-12-08 18:30:49 +01:00
|
|
|
Icinga 2 as monitoring core works best with [Icinga Web 2](https://www.icinga.com/products/icinga-web-2/)
|
|
|
|
|
as web interface.
|
|
|
|
|
|
|
|
|
|
More information can be found at [www.icinga.com](https://www.icinga.com/products/icinga-2/)
|
2015-06-19 09:36:12 +02:00
|
|
|
and inside the [documentation](doc/1-about.md).
|
2014-06-13 15:24:03 +02:00
|
|
|
|
2016-12-08 17:38:41 +01:00
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Icinga 2 and the Icinga 2 documentation are licensed under the terms of the GNU
|
|
|
|
|
General Public License Version 2, you will find a copy of this license in the
|
2017-01-12 14:04:00 +01:00
|
|
|
COPYING file included in the source package.
|
2016-12-08 17:38:41 +01:00
|
|
|
|
2014-06-13 15:24:03 +02:00
|
|
|
## Installation
|
|
|
|
|
|
2015-07-07 10:08:00 +02:00
|
|
|
Read the [INSTALL.md](INSTALL.md) file for more information about how to install it.
|
2014-06-13 15:24:03 +02:00
|
|
|
|
|
|
|
|
## Documentation
|
2012-05-25 16:56:47 +02:00
|
|
|
|
2015-07-07 10:08:00 +02:00
|
|
|
The documentation is located in the [doc/](doc/) directory. The latest documentation
|
2016-12-08 17:38:41 +01:00
|
|
|
is also available on https://docs.icinga.com
|
2014-06-13 15:24:03 +02:00
|
|
|
|
|
|
|
|
## Support
|
2012-05-25 16:56:47 +02:00
|
|
|
|
2016-12-08 17:38:41 +01:00
|
|
|
Check the project website at https://www.icinga.com for status updates. Join the
|
|
|
|
|
[community channels](https://www.icinga.com/community/get-involved/) for questions
|
|
|
|
|
or ask an Icinga partner for [professional support](https://www.icinga.com/services/support/).
|
|
|
|
|
|
|
|
|
|
## Development
|
|
|
|
|
|
|
|
|
|
The Git repository is located on [GitHub](https://github.com/Icinga/icinga2).
|
|
|
|
|
|
|
|
|
|
Icinga 2 is written in C++ and can be built on Linux/Unix and Windows.
|
|
|
|
|
Read more about development builds in the [INSTALL.md](INSTALL.md) file.
|
|
|
|
|
|
|
|
|
|
### Contributing
|
|
|
|
|
|
|
|
|
|
There are many ways to contribute to Icinga -- whether it be sending patches,
|
|
|
|
|
testing, reporting bugs, or reviewing and updating the documentation. Every
|
|
|
|
|
contribution is appreciated!
|
|
|
|
|
|
2017-01-19 11:23:26 +01:00
|
|
|
Please read the [contributing section](https://www.icinga.com/community/get-involved/)
|
|
|
|
|
first. Then you should have a look at the [roadmap](https://github.com/Icinga/icinga2/milestones)
|
|
|
|
|
and remaining [open issues](https://github.com/Icinga/icinga2/issues).
|
2016-12-08 17:38:41 +01:00
|
|
|
|
2017-01-19 11:23:26 +01:00
|
|
|
Pick issues you want to help resolve, fork the [repository on GitHub](https://github.com/Icinga/icinga2)
|
|
|
|
|
and send a pull request with your changes. Thanks for your contribution!
|
2016-12-08 17:38:41 +01:00
|
|
|
|
|
|
|
|
### Testing
|
|
|
|
|
|
|
|
|
|
Basic unit test coverage is provided by running `make test` during package builds.
|
|
|
|
|
Read the [INSTALL.md](INSTALL.md) file for more information about development builds.
|
|
|
|
|
|
|
|
|
|
Snapshot packages from the laster development branch are available inside the
|
2017-01-10 15:54:22 +01:00
|
|
|
[package repository](http://packages.icinga.com).
|
2016-12-08 17:38:41 +01:00
|
|
|
|
|
|
|
|
You can help test-drive the latest Icinga 2 snapshot packages inside the
|
|
|
|
|
[Icinga 2 Vagrant boxes](https://github.com/icinga/icinga-vagrant).
|
|
|
|
|
|
2016-12-08 18:30:49 +01:00
|
|
|
|
|
|
|
|
[About]: #about
|
|
|
|
|
[License]: #license
|
|
|
|
|
[Installation]: #installation
|
|
|
|
|
[Documentation]: #documentation
|
|
|
|
|
[Support]: #support
|
|
|
|
|
[Development]: #development
|
