Skip to content

Cleanup and update docs #39

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.

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

Merged
merged 3 commits into from
Dec 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
26 changes: 1 addition & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,7 @@

This fork was created to provide bug fixes and maintenance.

#### Table of Contents

1. [About](#about)
2. [License](#license)
3. [Support](#support)
4. [Requirements](#requirements)
5. [Documentation](#documentation)
6. [Contributing](#contributing)
You can find the complete documentation inside the [doc](doc/) folder.

## About

Expand All @@ -35,23 +28,6 @@ LICENSE file included in the source package.

Join the [Icinga community channels](https://icinga.com/community/) for questions.

## Requirements

* [Icinga Web 2](https://github.com/Icinga/icingaweb2) (>= 2.11)
* [Icinga DB Web](https://github.com/Icinga/icingadb-web) (>= 1.02)
* [Grafana](https://grafana.com/) (>= 7.0)
* [Grafana Image Renderer](https://grafana.com/grafana/plugins/grafana-image-renderer/) (when using proxy access)
* [PHP 8.1](https://www.php.net) (with curl and gd enabled)

A data source as a backend for Grafana. Either:

* [InfluxDB](https://docs.influxdata.com/influxdb/) (>= 1.0)
* [Graphite](https://graphiteapp.org)

## Documentation

You can find the complete documentation inside the [doc](doc/) folder.

## Thanks

This module borrows a lot from https://github.com/Icinga/icingaweb2-module-generictts & https://github.com/Icinga/icingaweb2-module-pnp.
Expand Down
2 changes: 1 addition & 1 deletion doc/02-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ git clone "${REPO_URL}" "${TARGET_DIR}"
Replace the version number with the latest available version from [Latest Release](https://github.com/NETWAYS/icingaweb2-module-grafana/releases/latest)

```
MODULE_VERSION="2.0.1"
MODULE_VERSION="3.0.0"
ICINGAWEB_MODULEPATH="/usr/share/icingaweb2/modules"
REPO_URL="https://github.com/NETWAYS/icingaweb2-module-grafana"
TARGET_DIR="${ICINGAWEB_MODULEPATH}/grafana"
Expand Down
2 changes: 1 addition & 1 deletion doc/06-create-grafana-dashboards-influxdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this example we create a dashboard for the command ping6, open the menu and g

![Create new Dashboard](images/06-create-new.png)

First go to the dashboard settings (![Settings](images/06-cog.png)) and change the name to `ITL-ping6`.
First go to the dashboard settings and change the name to `ITL-ping6`.
Also if you want add description, row names, links etc.
To save your changes, just hit the :floppy_disk: icon.

Expand Down
2 changes: 1 addition & 1 deletion doc/07-create-grafana-dashboards-graphite.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In this example we create a dashboard for the command ping6, open the menu and g

![Create new Dashboard](images/06-create-new.png)

First go to the dashboard settings (![Settings](images/06-cog.png)) and change the name to `ITL-ping6`.
First go to the dashboard settings and change the name to `ITL-ping6`.
Also if you want add description, row names, links etc.
To save your changes, just hit the :floppy_disk: icon.

Expand Down
Binary file removed doc/images/03-module_grafana_configuration01.png
Binary file not shown.
Binary file removed doc/images/06-cog.png
Binary file not shown.
Binary file removed doc/images/06-dashboard-panel-graphite-edit.png
Binary file not shown.
Binary file removed doc/images/grafana-import-base-metrics-dashboard.png
Binary file not shown.
Binary file removed doc/images/icingaweb2_grafana_screenshot_03.png
Binary file not shown.
Binary file removed doc/images/icingaweb2_grafana_screenshot_04.png
Binary file not shown.