Skip to content

Commit 0e183fb

Browse files
committed
Update READMe for grafana example
1 parent d00b5a3 commit 0e183fb

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

examples/grafana/README.md

+22-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
This docker compose file demonstrates how to use Grafana to connect to Proton and visualize the data.
66

7+
A YouTube video tutorial is available for visual learners: https://www.youtube.com/watch?v=cBRl1k9qWZc
8+
79
## Start the example
810

911
Simply run `docker compose up` in this folder. Two docker containers in the stack:
@@ -13,15 +15,33 @@ Simply run `docker compose up` in this folder. Two docker containers in the stac
1315

1416
TODO: we will update the compose file later to include a preconfigured Grafana.
1517

16-
## Use the Grafana plugin for Proton
18+
## Install and configure Grafana
19+
20+
Install Grafana if you haven't. Please note, this plugin is not available for Grafana Cloud users yet. It's being reviewed.
21+
22+
For Mac users, simply run `brew install grafana`.
23+
24+
Before the plugin is approved by Grafana, you need to set your Grafana running in development mode via changing /usr/local/etc/grafana/grafana.ini, setting `app_mode = development`.
25+
26+
Also searching for key word "plugin", and change `enable_alpha` and `allow_loading_unsigned_plugins` to
27+
```
28+
enable_alpha = true
29+
allow_loading_unsigned_plugins = timeplus-proton-datasource
30+
```
31+
32+
## Install the Proton plugin for Grafana
33+
34+
Currently you have to download the plugin from https://github.com/timeplus-io/proton-grafana-source/releases.
35+
36+
We have submited the plugin to Grafana. Once it's approved, you will be able to install it with Grafana UI and it will also work on Grafana Cloud.
1737

1838
Install the timeplus-proton-datasource in your Grafana plugin folder, such as
1939
- /var/lib/grafana/plugins (for Linux)
2040
- /usr/local/var/lib/grafana/plugins (for Homebrew on Mac)
2141

2242
Unzip the file and restart Grafana.
2343

24-
Before the plugin is approved by Grafana, you need to set your Grafana running in development mode via changing /usr/local/etc/grafana/grafana.ini, setting `app_mode = development`
44+
2545

2646
In the navigation menu, choose Connections -> Add new connection.
2747
Search for Proton and accept the default settings (localhost:8463 as proton connection)

0 commit comments

Comments
 (0)