Skip to content
This repository has been archived by the owner on Jul 2, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (31 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

39 lines (31 loc) · 1.25 KB
Raw

Contributing

Building and Installing the Plugin

You will need node + npm installed to build the plugin. The included Makefile makes the rest easy:

# Fetch all dependencies
make get-deps
# Build the plugin
make build
# Copy the plugin to your Grafana plugins directory
sudo rsync --recursive --delete dist/ /var/lib/grafana/plugins/cloudflare-app

Note: modern versions of Grafana do not load unsigned plugins by default. Be sure to set app_mode = development in Grafana's configuration file (usually /etc/grafana/grafana.ini) to allow the plugin to load.

Running Locally via Docker

The Makefile can spin up a local Grafana instance with the Cloudflare DNS plugin installed. You will need node + npm installed for the dependencies, as well as Docker, in order to build the plugin and run Grafana.

# Follow the instructions for building the plugin first.
# Run Grafana in Docker
make run

Visit http://localhost:3000/ and use admin:admin (user:password) to log in. Although we recommend installing the plugin and installing it into a permanent Grafana installation, the Docker approach can be useful for quick testing or debugging.