Skip to content

Commit

Permalink
Add Configuration and Launch sections
Browse files Browse the repository at this point in the history
  • Loading branch information
algorys committed Jun 29, 2016
1 parent 1c9dd87 commit d1acf6a
Show file tree
Hide file tree
Showing 4 changed files with 49 additions and 1 deletion.
29 changes: 29 additions & 0 deletions docs/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.. _config:

Configuration
=============

The application must be configure before running. Especially at the address of your **alignak-backend** and your **alignak-webui**.

You can configure application in file ``settings.cfg``, in root of app folder.

Configuration Parameters
========================

**Note:** The default configuration file contains some default url for a Alignak server test.

[Alignak-App] section
---------------------

This section contains main configuration for Alignak-App.

[Backend] section
-----------------

This section contains parameters to connect to *backend*.

[Webui] section
---------------

This section contains parameters to reach *webui*.

2 changes: 2 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Documentation content:

intro
install
conf
launch


Indices and tables
Expand Down
2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Requirements

pip install -r requirements.txt

| **WARNING:** if you encounter problems with `alignak_backend_client`_, download it an run *setup.py*
**WARNING:** if you encounter problems with `alignak_backend_client`_, download it an run *setup.py*

.. _alignak-backend: http://alignak-backend.readthedocs.io/en/latest/
.. _alignak-webui: http://alignak-web-ui.readthedocs.io/en/latest/
Expand Down
17 changes: 17 additions & 0 deletions docs/launch.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
.. _launch:

Launch the Alignak-App
======================

To launch the app, you have just to do::

python appalignak.py &

An icon of Alignak should normally appear in your notification bar.

You can open and see how many of Hosts (or Services) are DOWN, UNKNOWN or UP.

If you click a menu, it will open a web page to your Webui.

You can exit app just by clicking on *Quit*.

0 comments on commit d1acf6a

Please sign in to comment.