Skip to content

Commit 06880a1

Browse files
authored
docs: clarify how to configure Grafana (#872)
1 parent a8b9e98 commit 06880a1

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

docs/sources/_index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,28 @@ The binaries are hosted on [GitHub Releases][releases]. Download the appropriate
109109
binary for your platform, and run it from the terminal. You would run something
110110
like `./grafana-image-renderer server`; see `--help` for more information.
111111

112+
### Grafana configuration
113+
114+
Grafana includes options to specify where to find the renderer service, and
115+
which authentication token to use in communication. These options are:
116+
117+
```ini
118+
[rendering]
119+
; The URL is an HTTP(S) URL to the service, and its rendering endpoint.
120+
; By default, the path is `/render`. This can be changed with nginx or similar reverse proxies.
121+
server_url = http://renderer:8081/render
122+
123+
; The token is any _one_ token configured in the renderer service.
124+
; If you configured multiple tokens in the service, choose one for Grafana.
125+
; By default, a single token is configured, with the value of `-`.
126+
renderer_token = -
127+
```
128+
129+
With Docker or similar setups that use environment variables, the options are:
130+
131+
- `GF_RENDERING_SERVER_URL`, and
132+
- `GF_RENDERING_RENDERER_TOKEN`.
133+
112134
## Configuration
113135

114136
You can configure the service several ways:

0 commit comments

Comments
 (0)