Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Drop package instructions #214

Merged
merged 1 commit into from
Oct 25, 2023
Merged

doc: Drop package instructions #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 0 additions & 18 deletions doc/01-About.md
View file
Open in desktop

This file was deleted.

39 changes: 12 additions & 27 deletions doc/02-Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,23 @@
<!-- {% if index %} -->
# 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.
<!-- {% else %} -->
<!-- {% if not icingaDocs %} -->
## 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).
<!-- {% endif %} -->
* 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.
<!-- {% if not icingaDocs %} -->

**Note:** If you haven't installed this module from packages, then please adapt the schema path to the correct installation path.

<!-- {% endif %} -->
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:

Expand All @@ -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.
<!-- {% if not icingaDocs %} -->

**Note:** If you haven't installed this module from packages, then please adapt the schema path to the correct installation path.

<!-- {% endif %} -->
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:

Expand All @@ -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).
<!-- {% endif %} --><!-- {# end else if index #} -->
16 changes: 0 additions & 16 deletions doc/02-Installation.md.d/From-Source.md
View file
Open in desktop

This file was deleted.

14 changes: 4 additions & 10 deletions doc/03-Configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<!-- {% if not icingaDocs %} -->

> **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`.

<!-- {% endif %} -->
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.

Expand Down