upstream/icingaweb2-module-graphite
1
0
Fork 0
mirror of https://github.com/Icinga/icingaweb2-module-graphite.git synced 2026-05-28 04:34:57 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: recommend to install from packages

Browse source
This commit is contained in:
Alexander A. Klimov 2022-09-22 14:57:54 +02:00
parent c916738ab1
commit bb7deb03aa
3 changed files with 37 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -19,7 +19,7 @@ the monitoring module.
## Documentation
* [Installation](doc/02-Installation.md)
* [Installation](https://icinga.com/docs/icinga-web-graphite-integration/latest/doc/02-Installation/)
* [Configuration](doc/03-Configuration.md)
* [Templates](doc/04-Templates.md)
* [Development](doc/06-Development.md)

43
doc/02-Installation.md
View file

@ -1,15 +1,24 @@
# Installation
<!-- {% if index %} -->
# Installing Icinga Web Graphite Integration
## Requirements
It is recommended to use prebuilt packages
for all supported platforms from our official release repository.
Of course [Icinga Web](https://icinga.com/docs/icinga-web) itself
is required to run its Graphite integration.
The latter uses Graphite Web, so that is required as well.
If they are not already set up, it is best to do this first.
* PHP (>= 7.2)
* Icinga Web (>= 2.9)
* Icinga Web libraries:
* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (>= 0.9)
* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (>= 0.11)
* Icinga Web modules:
* The `monitoring` or `icingadb` module needs to be configured and enabled.
* Graphite and Graphite Web
The following steps will guide you through installing
and setting up Icinga Web Graphite Integration.
<!-- {% else %} -->
<!-- {% if not icingaDocs %} -->
## 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-graphite` package
or install [from source](02-Installation.md.d/From-Source.md).
<!-- {% endif %} --><!-- {# end if not icingaDocs #} -->
## Prepare Icinga 2
@ -33,15 +42,7 @@ And then restart Icinga2. Enabling thresholds is not a hard requirement.
However, some templates look better if they are able to render a max
value or similar.
## Configuring the Icinga Web Graphite Integration
## Install the Icinga Web Graphite Integration
Install it [like any other module](https://icinga.com/docs/icinga-web-2/latest/doc/08-Modules/#installation).
Use `graphite` as name.
## Further reading
* [Configuration](03-Configuration.md)
* [Templates](04-Templates.md)
* [Troubleshooting](05-Troubleshooting.md)
For required additional steps see the [Configuration](03-Configuration.md) chapter.
<!-- {% endif %} --><!-- {# end else if index #} -->

14
doc/02-Installation.md.d/From-Source.md Normal file
View file

@ -0,0 +1,14 @@
# Installing Icinga Web Graphite Integration 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 `graphite` as the module name. The following requirements must also be met.
## Requirements
* PHP (≥7.2)
* [Icinga Web](https://github.com/Icinga/icingaweb2) (≥2.9)
* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (≥1.0)
* [Icinga PHP Library (ipl)](https://github.com/Icinga/icinga-php-library) (≥0.9)
* [Icinga PHP Thirdparty](https://github.com/Icinga/icinga-php-thirdparty) (≥0.11)
<!-- {% include "02-Installation.md" %} -->