Misthios/grafana-zabbix
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: update building documentation

Browse Source
This commit is contained in:
Alexander Zobnin
2018-10-22 11:13:17 +03:00
parent 1d7ff38f31
commit 2cc1065e80
2 changed files with 36 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/sources/installation/index.md
View File

@@ -16,7 +16,7 @@ Install zabbix plugin
grafana-cli plugins install alexanderzobnin-zabbix-app grafana-cli plugins install alexanderzobnin-zabbix-app
``` ```
Restart grafana after installing plugins Restart grafana after installing plugins
```sh ```sh
service grafana-server restart service grafana-server restart
``` ```
@@ -24,72 +24,8 @@ service grafana-server restart
Read more about installing plugins in [Grafana docs](http://docs.grafana.org/plugins/installation/) Read more about installing plugins in [Grafana docs](http://docs.grafana.org/plugins/installation/)
## From github repo ## From github repo
Just clone plugin repo into your plugin directory **WARNING!** This way doesn't work anymore (`dist/` folder was removed from git). Use `grafana-cli` or build plugin from sources.
```sh
cd /var/lib/grafana/plugins
git clone https://github.com/alexanderzobnin/grafana-zabbix
```
Then restart grafana server.
```sh
service grafana-server restart
```
Using this way you can easy upgrade plugin just running
```sh
cd /var/lib/grafana/plugins/grafana-zabbix
git pull
service grafana-server restart
```
## From special repo
**WARNING!** This way is deprecated. Now main repo (https://github.com/alexanderzobnin/grafana-zabbix) contains builded plugin.
You can use [grafana-zabbix-app](https://github.com/alexanderzobnin/grafana-zabbix-app) repo,
which contains latest builded version of plugin.
```sh
cd /var/lib/grafana/plugins
git clone https://github.com/alexanderzobnin/grafana-zabbix-app
```
Then restart grafana server.
Using this way you can easy upgrade plugin just running
```sh
cd /var/lib/grafana/plugins/grafana-zabbix-app
git pull
service grafana-server restart
```
## Building from sources ## Building from sources
You need NodeJS, npm and Grunt for building plugin from sources. Read more about required versions
in [Grafana docs](http://docs.grafana.org/project/building_from_source/).
```sh If you want to build a package yourself, or contribute - read [building instructions](/installation/run_from_master).
git clone https://github.com/alexanderzobnin/grafana-zabbix.git
cd grafana-zabbix
npm install
npm install -g grunt-cli
grunt
```
Plugin will built into *dist/* directory. Then you can copy it into your grafana plugins directory
or set path to compiled plugin in grafana config:
```ini
[plugin.zabbix]
path = /home/your/clone/dir/grafana-zabbix/dist
```
If you need to upgrade plugin use
```sh
git pull
grunt
```
Restart Grafana server
```sh
service grafana-server restart
```

33
docs/sources/installation/run_from_master.md Normal file
View File

@@ -0,0 +1,33 @@
page_title: Run Grafana-Zabbix from master
page_description: Building instructions for Grafana-Zabbix.
# Run from master
If you want to build a package yourself, or contribute - here is a guide for how to do that.
### Dependencies
- NodeJS LTS
### Building plugin
```bash
npm install -g yarn
yarn install --pure-lockfile
yarn build
```
### To build plugin and rebuild on file change
```bash
yarn watch
```
### Run tests
```bash
yarn test
```
### Run tests on file change
```bash
yarn jest
```