Adding upstream version 0.10.1.upstream/0.10.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 71 insertions, 0 deletions

diff --git a/doc/02-Installation.md b/doc/02-Installation.md
new file mode 100644
index 0000000..532d0ff
--- /dev/null
+++ b/doc/02-Installation.md
@@ -0,0 +1,71 @@
+# Installation
+
+## Requirements
+
+* PHP (>= 7.0)
+* Icinga Web 2 (>= 2.9)
+* Icinga Web 2 libraries:
+  * [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (>= 0.8)
+* Icinga Web 2 modules:
+  * [reporting](https://github.com/Icinga/icingaweb2-module-reporting) (>= 0.9)
+* MySQL, MariaDB or PostgreSQL
+
+## Database Setup
+
+### MySQL / MariaDB
+
+#### Grant Required Privileges
+
+Skip this step if you used the database configuration wizard during the Icinga 2 installation.
+
+Please proceed only if you did the setup manually as described here: 
+https://icinga.com/docs/icinga2/latest/doc/02-getting-started/#setting-up-the-mysql-database
+
+The import of the SQL functions will fail due to insufficient privileges.
+The required privileges are `CREATE, CREATE ROUTINE, ALTER ROUTINE, EXECUTE`. 
+
+The following example assumes that your MySQL database is hosted on **localhost**
+and your Icinga database and user is named **icinga2**:
+
+```
+GRANT CREATE, CREATE ROUTINE, ALTER ROUTINE, EXECUTE ON icinga2.* TO 'icinga2'@'localhost';
+```
+
+Please adapt the host, database and username to your environment.
+
+#### Import Database Files
+
+The module ships with database functions for calculating the host and service availability in `etc/schema/mysql`.
+Please import those files into your Icinga database.
+
+The following example assumes that your Icinga database and user is named **icinga2**:
+
+```
+mysql -p -u icinga2 icinga2 < schema/mysql/slaperiods.sql
+mysql -p -u icinga2 icinga2 < schema/mysql/get_sla_ok_percent.sql
+```
+
+Please adapt the database and username to your environment.
+
+### PostgreSQL
+
+#### Import Database Files
+
+The module ships with database functions for calculating the host and service availability in `etc/schema/postgresql`.
+Please import those files into your Icinga database.
+
+The following example assumes that your Icinga database and user is named **icinga2**:
+
+```
+psql -U icinga2 icinga2 < schema/postgresql/slaperiods.sql
+psql -U icinga2 icinga2 < schema/postgresql/get_sla_ok_percent.sql
+```
+
+Please adapt the database and username to your environment.
+
+## Installation
+
+Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation).
+Use `idoreports` as name.
+
+This concludes the installation. You should now be able to create host and service availability reports.