diff --git a/README.md b/README.md index d35298dd..b7d3ce1b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ Icinga Director =============== -This is going to be the new Icinga 2 config tool. Not for productional use. YET. +Icinga Director has been designed to make Icinga 2 configuration handling easy. +It tries to target two main audiences: + +* Users with the desire to completely automate their datacenter +* Sysops willing to grant their "point & click" users a lot of flexibility + +What makes Icinga Director so special is the fact that it tries to target both +of them at once. + + +Requirements +============ + +* Icinga 2 (>= 2.4.0) +* Icinga Web 2 (>= 2.1.0) +* MySQL or PostgreSQL database +* PostgreSQL: the schema is lacking behind right now, we'll fix this soon. If you want to start testing Director today please use MySQL Installation ============ @@ -29,6 +45,10 @@ Create Icinga Director database Configure Icinga Web 2 ---------------------- +As with any Icinga Web 2 module, installation is pretty straight-forward. In +case you're installing it from source all you have to do is to drop the director +module in one of your module paths. Then go to your web frontend, Configuration, +Modules, director - and enable the module. In your web frontend please go to System / Configuration / Resources and create a new database resource pointing to your newly created database. Last but not least you have to tell the director module to use this newly created database