Make sure you have docker installed and running.
Create a Github personal access token with the appropriate permissions.
- Set the following environment variables:
GITHUB_TOKEN - Run
./build.sh - Run
./run.sh - Open a browser to
http://localhost:3000/ - Login with
admin/admin - Navigate to Dashboards->GitHub Default
- Profit!
Grafana provisioning of dashboards and data sources occurs by placing the provisioning directory in /etc/grafana/provisioning of the docker image. For this reason, we are building a custom docker image and adding the provisioning directory as well as the dashboards needed via the Dockerfile.
To enable faster startup times, grafana plugins are pre-installed into the custom docker image by specifying the plugins as a --build-arg in the build.sh.
New dashboards can be created or modified locally, then exported to a json file and checked into the dashboards directory, or any folder within. When exporting a dashboard, do not enable the Export for sharing externally option.
Stop and delete the grafana docker container by running ./cleanup.sh.