===================================
Presentation of the Alignak project
===================================

*Alignak project - modern Nagios compatible monitoring framework*

.. image:: https://api.travis-ci.org/Alignak-monitoring/alignak.svg?branch=develop
    :target: https://travis-ci.org/Alignak-monitoring/alignak
    :alt: Develop branch build status

.. image:: https://landscape.io/github/Alignak-monitoring/alignak/develop/landscape.svg?style=flat
    :target: https://landscape.io/github/Alignak-monitoring/alignak/develop
    :alt: Development code static analysis

.. image:: https://coveralls.io/repos/Alignak-monitoring/alignak/badge.svg?branch=develop
    :target: https://coveralls.io/r/Alignak-monitoring/alignak
    :alt: Development code tests coverage

.. image:: https://readthedocs.org/projects/alignak-doc/badge/?version=latest
    :target: http://alignak-doc.readthedocs.org/en/latest/?badge=latest
    :alt: Lastest documentation Status

.. image:: https://readthedocs.org/projects/alignak-doc/badge/?version=develop
    :target: http://alignak-doc.readthedocs.org/en/update/?badge=develop
    :alt: Development branch documentation Status

.. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat
    :target: http://webchat.freenode.net/?channels=%23alignak
    :alt: Join the chat #alignak on freenode.net

.. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
    :target: http://www.gnu.org/licenses/agpl-3.0
    :alt: License AGPL v3


`Alignak <http://www.alignak.net>`_ is a modern monitoring framework based on Shinken.

Its main goal is to give users a flexible and complete solution for their monitoring system. Alignak is designed to scale to large environments.

Alignak is backwards-compatible with the Nagios/Shinken configuration standard and plugins. It works on any operating system and architecture that supports Python, which includes Windows (not yet), GNU/Linux and FreeBSD.

Alignak is licensed under the Gnu Affero General Public Licence version 3 (AGPLv3). Unless specified by another header, this licence applies to all the files in this repository.


Documentation
-------------

`Alignak Web Site <http://www.alignak.net>`_ includes much documentation and introduces the Alignak main features, such as the backend, the webui, the tight integration with timeseries databases, ...

Alignak project has `an online documentation page <http://alignak-monitoring.github.io/documentation/>`_. We try to have as much documentation as possible and to keep this documentation simple and understandable. For sure the documentation is not yet complete, but you can help us ;)

Click on one of the docs badges on this page to browse the documentation.


Requirements
------------

See the requirements file in the repository's root


Installing Alignak
------------------

See the `installation documentation <https://alignak-doc.readthedocs.org/en/latest/02_installation/index.html>`_.
