From 8efabd5cb9d33b63b17886feb968e3fd2b92a020 Mon Sep 17 00:00:00 2001 From: Mariell Hoversholm Date: Fri, 21 Nov 2025 13:09:25 +0100 Subject: [PATCH 1/2] docs: clarify how to configure Grafana --- docs/sources/_index.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index bd137ccd..7dc07b66 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -109,6 +109,24 @@ The binaries are hosted on [GitHub Releases][releases]. Download the appropriate binary for your platform, and run it from the terminal. You would run something like `./grafana-image-renderer server`; see `--help` for more information. +### Grafana configuration + +Grafana's configuration includes options to specify where to find the renderer +service, and which authentication token to use in communication. These options +are, in INI format: + +```ini +[rendering] +; The URL is an HTTP(S) URL to the service, and its rendering endpoint. +; By default, the path is `/render`. This can be changed with nginx or similar reverse proxies. +server_url = http://renderer:8081/render + +; The token is any _one_ token configured in the renderer service. +; If you configured multiple tokens in the service, choose one for Grafana. +; By default, a single token is configured, with the value of `-`. +renderer_token = - +``` + ## Configuration You can configure the service several ways: From d1adaaa165d3ef9836ecf5d8120d101d04642316 Mon Sep 17 00:00:00 2001 From: Mariell Hoversholm Date: Fri, 21 Nov 2025 13:56:43 +0100 Subject: [PATCH 2/2] fix: don't use possessive --- docs/sources/_index.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/sources/_index.md b/docs/sources/_index.md index 7dc07b66..1fb981bf 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -111,9 +111,8 @@ like `./grafana-image-renderer server`; see `--help` for more information. ### Grafana configuration -Grafana's configuration includes options to specify where to find the renderer -service, and which authentication token to use in communication. These options -are, in INI format: +Grafana includes options to specify where to find the renderer service, and +which authentication token to use in communication. These options are: ```ini [rendering] @@ -127,6 +126,11 @@ server_url = http://renderer:8081/render renderer_token = - ``` +With Docker or similar setups that use environment variables, the options are: + +- `GF_RENDERING_SERVER_URL`, and +- `GF_RENDERING_RENDERER_TOKEN`. + ## Configuration You can configure the service several ways: