File tree Expand file tree Collapse file tree 1 file changed +30
-3
lines changed Expand file tree Collapse file tree 1 file changed +30
-3
lines changed Original file line number Diff line number Diff line change 22
33Detect angular dashboards in a running Grafana instance using Grafana API.
44
5+ Compatible with Grafana OSS, Grafana Enterprise, On-Prem and Grafana Cloud.
6+
57## Configuration
68
79The program requires a service account and API key to work properly.
810
911Configuration changes slightly depending on your version of Grafana.
1012
13+ We recommend using Grafana >= 10.1.0, otherwise Angular private plugins (that are not in Grafana's catalog) will be ignored.
14+
1115### Grafana >= 10.1.0
1216
1317Create a service account with ` Viewer ` role.
@@ -24,18 +28,41 @@ The reason behind admin rights is that the plugins endpoint returns all plugins
2428
2529Then, create a service account token for the newly created service account and set it to the ` GRAFANA_TOKEN ` env var.
2630
31+
32+
2733## Usage
2834
29- ### Building from source
35+ ### Pre-built binaries
36+
37+ You can download pre-built binaries from the [ releases] ( https://github.com/grafana/detect-angular-dashboards/releases ) section.
38+
39+ Then, run the program:
3040
3141``` bash
32- go build -v
3342GRAFANA_TOKEN=abcd ./detect-angular-dashboards [GRAFANA_URL= http://127.0.0.1:3000/api]
43+ ````
44+
45+ # ## Building from source
46+
47+ You need to install Go and [Mage](https://magefile.org/).
48+
49+ Then, clone the repository, build and run the program:
50+
51+ ` ` ` bash
52+ mage build:current
53+ GRAFANA_TOKEN=abcd ./dist/linux_amd64/detect-angular-dashboards [GRAFANA_URL= http://127.0.0.1:3000/api]
3454` ` `
3555
36- ### Running with Docker
56+ # ## Docker image
57+
58+ Clone the repository and build the Docker image:
59+
3760` ` ` bash
3861docker build -t detect-angular-dashboards .
3962docker run --rm -it -e GRAFANA_TOKEN=abcd detect-angular-dashboards http://172.17.0.1:3000/api
4063` ` `
4164
65+
66+ # # LICENSE
67+
68+ Apache License 2.0
You can’t perform that action at this time.
0 commit comments