Skip to main content

Contributing

  1. Create a fork of the repo.
  2. Clone the fork to the grafana plugins folder on your local machine.
  3. Optional: create a new branch.
  4. Setup grafana for developing HTMLGraphics
  5. Follow the DEVELOPMENT_GUIDE.
  6. Implement the feature/fix.
  7. Add/change the documentation as needed.
  8. Create a commit following the Conventional Commits
  9. Push the changes to your fork on Github, the remote origin.
  10. From your fork open a pull request to the main branch.

Setup grafana for developing HTMLGraphics​

Local installation​

The grafana directory could be somewhere else than written here. Please check https://grafana.com/docs/grafana/v9.1/administration/configuration to find where your grafana directory is located.

Create a custom.ini file at the grafana directory /etc/grafana/ and add the following content:

custom.ini

app_mode = development

[plugins]

allow_loading_unsigned_plugins = true

Docker compose​

docker-compose.yml

tip

Set the volumes path to ./grafana-plugins and run the docker-compose.yml file above the grafana-plugins folder. (The fork needs to be cloned into ./grafana-plugins).

version: '3'
services:
  grafana:
    image: grafana/grafana
    container_name: grafana
    restart: always
    networks:
      - grafana
    ports:
      - 3001:3000
    volumes:
      - /path-to-grafana-plugins/grafana-plugins:/var/lib/grafana/plugins
      - grafana-storage:/var/lib/grafana
    environment:
      - GF_APP_MODE=development
      - GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=gapit-htmlgraphics-panel

networks:
  grafana:
    name: grafana

volumes:
  grafana-storage:

Run in the same folder as the docker-compose.yml file

docker-compose up -d