Skip to content

docs: clarify how to configure Grafana #872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 21, 2025
Merged

docs: clarify how to configure Grafana #872

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8efabd5
docs: clarify how to configure Grafana
Proximyst Nov 21, 2025
d1adaaa
fix: don't use possessive
Proximyst Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/sources/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading