diff --git a/docs/sources/_index.md b/docs/sources/_index.md index bd137ccd..1fb981bf 100644 --- a/docs/sources/_index.md +++ b/docs/sources/_index.md @@ -109,6 +109,28 @@ 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 includes options to specify where to find the renderer service, and +which authentication token to use in communication. These options are: + +```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 = - +``` + +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: