File README.SUSE of Package icingaweb2-module-reporting

Database Setup
==============
The module needs a MySQL/MariaDB database with the schema that's provided in the etc/schema/mysql.sql file.

Example command for creating the MySQL/MariaDB database. Please change the password:

CREATE DATABASE reporting;
GRANT SELECT, INSERT, UPDATE, DELETE, DROP, CREATE VIEW, INDEX, EXECUTE ON reporting.* TO reporting@localhost IDENTIFIED BY 'secret';

After, you can import the schema using the following command:

mysql -p -u root reporting < schema/mysql.sql

Module Installation
===================
1. Just drop this module to a reporting subfolder in your Icinga Web 2 module path.
2. Log in with a privileged user in Icinga Web 2 and enable the module in 
   Configuration -> Modules -> reporting. Or use the icingacli and run icingacli module enable reporting.
3. Once you've set up the database, create a new Icinga Web 2 resource for it 
   using the Configuration -> Application -> Resources menu. 
   Make sure that you set the character set to utf8mb4.
4. The next step involves telling the Reporting module which database resource to use.
   This can be done in Configuration -> Modules -> reporting -> Backend.

This concludes the installation. You should now be able create reports.

You also must enable modules: ipl, pdfexport and reactbundle.

Scheduler Daemon
================

systemctl enable icinga-reporting.service


Upgrading to Version x.y.z
==========================

Icinga Reporting version x.y.z requires a schema update for the database.
A new table template, linked to table report, has been introduced.
Please find the upgrade script in schema/mysql-migrations.

You may use the following command to apply the database schema upgrade file:

# mysql -u root -p reporting <schema/mysql-migrations/vx.y.z.sql