setup docs hirearchy
This commit is contained in:
52
docs/sources/installation/_index.md
Normal file
52
docs/sources/installation/_index.md
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: Installation
|
||||
menuTitle: Installation
|
||||
description: Installation instructions for Grafana-Zabbix.
|
||||
aliases:
|
||||
keywords:
|
||||
- data source
|
||||
- zabbix
|
||||
labels:
|
||||
products:
|
||||
- oss
|
||||
- grafana cloud
|
||||
weight: 200
|
||||
---
|
||||
|
||||
## Choosing plugin version
|
||||
|
||||
Currently (in version `4.x.x`) Grafana-Zabbix plugin supports Zabbix versions `4.x` and `5.x`. Zabbix `3.x` is not supported anymore. Generally, latest plugin should work with latest Grafana version, but if you have any compatibility issue, try to downgrade to previous minor release of Grafana. It's also helpful to report (but use search first to avoid duplicating issues) compatibility issues to the [GitHub](https://github.com/grafana/grafana-zabbix/issues).
|
||||
|
||||
## Using grafana-cli tool
|
||||
|
||||
Get list of available plugins
|
||||
|
||||
```sh
|
||||
grafana-cli plugins list-remote
|
||||
```
|
||||
|
||||
Install zabbix plugin
|
||||
|
||||
```sh
|
||||
grafana-cli plugins install alexanderzobnin-zabbix-app
|
||||
```
|
||||
|
||||
Restart grafana after installing plugins
|
||||
|
||||
```sh
|
||||
systemctl restart grafana-server
|
||||
```
|
||||
|
||||
Read more about installing plugins in [Grafana docs](https://grafana.com/docs/plugins/installation/)
|
||||
|
||||
**WARNING!** The only reliable installation method is `grafana-cli`. Any other way should be treated as a workaround and doesn't provide any backward-compatibility guaranties.
|
||||
|
||||
## From github releases
|
||||
|
||||
Starting from version 4.0, each plugin release on GitHub contains packaged plugin. To install it, go to [releases](https://github.com/grafana/grafana-zabbix/releases) page, pick release you want to get and click on `Assets`. Built plugin packaged into `zip` archive having name `alexanderzobnin-zabbix-app-x.x.x.zip`. Download it, unpack into your Grafana plugins directory and restart grafana server. Each plugin package contains [digital signature](https://grafana.com/docs/grafana/latest/plugins/plugin-signatures/) which allows Grafana to verify that plugin was published by it's owner and files are not modified.
|
||||
|
||||
**Note**: `since` plugin version 4.0, `grafana-cli` downloads plugin from GitHub release. So downloading plugin package manually, you get the same package as via `grafana-cli`.
|
||||
|
||||
## Building from sources
|
||||
|
||||
If you want to build a package yourself, or contribute - read [building instructions](./building-from-sources).
|
||||
53
docs/sources/installation/building-from-sources.md
Normal file
53
docs/sources/installation/building-from-sources.md
Normal file
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Building from sources
|
||||
menuTitle: Building from sources
|
||||
description: Building instructions for Grafana-Zabbix.
|
||||
aliases:
|
||||
keywords:
|
||||
- data source
|
||||
- zabbix
|
||||
labels:
|
||||
products:
|
||||
- oss
|
||||
- grafana cloud
|
||||
weight: 210
|
||||
---
|
||||
|
||||
If you want to build a package yourself, or contribute - here is a guide for how to do that.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- [NodeJS](https://nodejs.org/) LTS
|
||||
- [Go](https://golang.org/) version 1.14 or above
|
||||
|
||||
## Building
|
||||
|
||||
### Install dependencies
|
||||
|
||||
```bash
|
||||
make install
|
||||
```
|
||||
|
||||
### Build plugin (for all platforms)
|
||||
|
||||
```bash
|
||||
make dist
|
||||
```
|
||||
|
||||
### To run frontend and rebuild on file change
|
||||
|
||||
```bash
|
||||
make run-frontend
|
||||
```
|
||||
|
||||
### To run backend and rebuild on file change
|
||||
|
||||
```bash
|
||||
make run-backend
|
||||
```
|
||||
|
||||
### Run tests
|
||||
|
||||
```bash
|
||||
make test
|
||||
```
|
||||
20
docs/sources/installation/upgrade.md
Normal file
20
docs/sources/installation/upgrade.md
Normal file
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Upgrade
|
||||
menuTitle: Upgrade
|
||||
description: Upgrade instructions for Grafana-Zabbix.
|
||||
aliases:
|
||||
keywords:
|
||||
- data source
|
||||
- zabbix
|
||||
labels:
|
||||
products:
|
||||
- oss
|
||||
- grafana cloud
|
||||
weight: 220
|
||||
---
|
||||
|
||||
## Upgrade from 2.x
|
||||
|
||||
After [enabling](../../configuration/#enable-plugin) Zabbix App go to _Data Sources_, open your configured Zabbix
|
||||
data source end select _Zabbix_ from _Type_ list again. This is needed because plugin id was changed
|
||||
in Grafana 3.0.
|
||||
Reference in New Issue
Block a user