diff --git a/docs/sources/setup-grafana/configure-grafana/_index.md b/docs/sources/setup-grafana/configure-grafana/_index.md index 19cd20122d5..ec7f3be2a73 100644 --- a/docs/sources/setup-grafana/configure-grafana/_index.md +++ b/docs/sources/setup-grafana/configure-grafana/_index.md @@ -1754,6 +1754,12 @@ This option does not require any configuration. Options to configure a remote HTTP image rendering service, e.g. using https://github.com/grafana/grafana-image-renderer. +#### renderer_token + +> **Note**: Available in Grafana v9.1.2 and Image Renderer v3.6.1 or later. + +An auth token will be sent to and verified by the renderer. The renderer will deny any request without an auth token matching the one configured on the renderer. + ### server_url URL to a remote HTTP image renderer service, e.g. http://localhost:8081/render, will enable Grafana to render panels and dashboards to PNG-images using HTTP requests to an external service. diff --git a/docs/sources/setup-grafana/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md index 0bf6c283e0d..40ea9cf221a 100644 --- a/docs/sources/setup-grafana/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -54,6 +54,34 @@ docker run -d --name=renderer --network=host -v /some/path/config.json:/usr/src/ You can see a docker-compose example using a custom configuration file [here](https://github.com/grafana/grafana-image-renderer/tree/master/devenv/docker/custom-config). +### Security + +> **Note:** This feature is available in Image Renderer v3.6.1 and later. + +You can restrict access to the rendering endpoint by specifying a secret token. The token should be configured in the Grafana configuration file and the renderer configuration file. This token is important when you run the plugin in remote rendering mode. + +Renderer versions v3.6.1 or later require a Grafana version with this feature. These include: + +- Grafana v9.1.2 or later +- Grafana v9.0.8 or later patch releases +- Grafana v8.5.11 or later patch releases +- Grafana v8.4.11 or later patch releases +- Grafana v8.3.11 or later patch releases + +```bash +AUTH_TOKEN=- +``` + +```json +{ + "security": { + "authToken": "-" + } +} +``` + +See the [Grafana configuration]({{< relref "../configure-grafana/#renderer_token" >}}) for how to configure the token in Grafana. + ### Rendering mode You can instruct how headless browser instances are created by configuring a rendering mode. Default is `default`, other supported values are `clustered` and `reusable`.