diff --git a/doc/01-About.md b/doc/01-About.md deleted file mode 100644 index 8067bdf..0000000 --- a/doc/01-About.md +++ /dev/null @@ -1,18 +0,0 @@ -# Icinga Reporting - -Icinga Reporting is the central component for reporting related functionality in the monitoring web frontend and -framework Icinga Web. The engine allows you to create reports over a specified time period for ad-hoc and scheduled -generation of reports. Other modules use the provided functionality in order to provide concrete reports. - -## Host/Service SLA Reports - -With Icinga DB Web there is no additional module required. - -If you are still using the monitoring module, please also install the -[idoreports](https://icinga.com/docs/icinga-reporting/latest/idoreports/doc/02-Installation/) module. - -## Documentation - -* [Installation](02-Installation.md) -* [Configuration](03-Configuration.md) -* [Upgrading](80-Upgrading.md) diff --git a/doc/02-Installation.md b/doc/02-Installation.md index 258f806..8b04fff 100644 --- a/doc/02-Installation.md +++ b/doc/02-Installation.md @@ -1,32 +1,23 @@ - # Installing Icinga Reporting -The recommended way to install Icinga Reporting and its dependencies is to use prebuilt packages for all supported -platforms from our official release repository. Please note that [Icinga Web](https://icinga.com/docs/icinga-web) is -required and if it is not already set up, it is best to do this first. +Please see the Icinga Web documentation on +[how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source. +Make sure you use `reporting` as the module name. The following requirements must also be met. -To upgrade an existing Icinga Reporting installation to a newer version, see the [Upgrading](80-Upgrading.md) documentation -for the necessary steps. - - +## Requirements -## Installing the Package - -If the [repository](https://packages.icinga.com) is not configured yet, please add it first. -Then use your distribution's package manager to install the `icinga-reporting` package -or install [from source](02-Installation.md.d/From-Source.md). - +* PHP (≥7.2) +* MySQL or PostgreSQL PDO PHP libraries +* The following PHP modules must be installed: `mbstring` +* [Icinga Web](https://github.com/Icinga/icingaweb2) (≥2.9) +* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.13.0) +* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (≥0.12.0) ## Setting up the Database ### Setting up a MySQL or MariaDB Database -The module needs a MySQL/MariaDB database with the schema that's provided in the `/usr/share/icingaweb2/modules/reporting/schema/mysql.schema.sql` file. - - -**Note:** If you haven't installed this module from packages, then please adapt the schema path to the correct installation path. - - +The module needs a MySQL/MariaDB database with the schema that's provided in the `schema/mysql.schema.sql` file. You can use the following sample command for creating the MySQL/MariaDB database. Please change the password: @@ -43,12 +34,7 @@ mysql -p -u root reporting < /usr/share/icingaweb2/modules/reporting/schema/mysq ## Setting up a PostgreSQL Database -The module needs a PostgreSQL database with the schema that's provided in the `/usr/share/icingaweb2/modules/reporting/schema/pgsql.schema.sql` file. - - -**Note:** If you haven't installed this module from packages, then please adapt the schema path to the correct installation path. - - +The module needs a PostgreSQL database with the schema that's provided in the `schema/pgsql.schema.sql` file. You can use the following sample command for creating the PostgreSQL database. Please change the password: @@ -68,4 +54,3 @@ psql -U reporting reporting -a -f /usr/share/icingaweb2/modules/reporting/schema ``` This concludes the installation. Now continue with the [configuration](03-Configuration.md). - diff --git a/doc/02-Installation.md.d/From-Source.md b/doc/02-Installation.md.d/From-Source.md deleted file mode 100644 index 6ab03ba..0000000 --- a/doc/02-Installation.md.d/From-Source.md +++ /dev/null @@ -1,16 +0,0 @@ -# Installing Icinga Reporting from Source - -Please see the Icinga Web documentation on -[how to install modules](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation) from source. -Make sure you use `reporting` as the module name. The following requirements must also be met. - -## Requirements - -* PHP (≥7.2) -* MySQL or PostgreSQL PDO PHP libraries -* The following PHP modules must be installed: `mbstring` -* [Icinga Web](https://github.com/Icinga/icingaweb2) (≥2.9) -* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.13.0) -* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (≥0.12.0) - - diff --git a/doc/03-Configuration.md b/doc/03-Configuration.md index 61da001..e789aef 100644 --- a/doc/03-Configuration.md +++ b/doc/03-Configuration.md @@ -39,17 +39,11 @@ icingacli reporting schedule run This command schedules the execution of all applicable reports. -The default `systemd` service of this module, shipped with package installations, uses this command as well. +The `systemd` service of this module uses this command as well. - - -> **Note** -> -> If you haven't installed this module from packages, you have to configure this as a `systemd` service yourself by just -> copying the example service definition from `/usr/share/icingaweb2/modules/reporting/config/systemd/icinga-reporting.service` -> to `/etc/systemd/system/icinga-reporting.service`. - - +To configure this as a `systemd` service, copy the example service definition from +`/usr/share/icingaweb2/modules/reporting/config/systemd/icinga-reporting.service` +to `/etc/systemd/system/icinga-reporting.service`. You can run the following command to enable and start the daemon.