From f0e63c6fd50616e17d3bea6d1dc9560f96f94420 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Agn=C3=A8s=20Toulet?= <35176601+AgnesToulet@users.noreply.github.com> Date: Tue, 18 Jun 2024 16:11:59 +0200 Subject: [PATCH] Doc: Update image rendering with HTTPS configuration (#88505) * Doc: Update image rendering with HTTPS configuration * add version * Update docs/sources/setup-grafana/image-rendering/_index.md Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --------- Co-authored-by: Christopher Moyer <35463610+chri2547@users.noreply.github.com> --- .../setup-grafana/image-rendering/_index.md | 41 +++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/sources/setup-grafana/image-rendering/_index.md b/docs/sources/setup-grafana/image-rendering/_index.md index d9438fa0142..ed04d5cc64e 100644 --- a/docs/sources/setup-grafana/image-rendering/_index.md +++ b/docs/sources/setup-grafana/image-rendering/_index.md @@ -207,6 +207,47 @@ HTTP_PORT=0 } ``` +#### HTTP protocol + +{{% admonition type="note" %}} +HTTPS protocol is supported in the image renderer v3.11.0 and later. +{{% /admonition %}} + +Change the protocol of the server, it can be `http` or `https`. Default is `http`. + +```json +{ + "service": { + "protocol": "http" + } +} +``` + +#### HTTPS certificate and key file + +Path to the image renderer certificate and key file used to start an HTTPS server. + +```json +{ + "service": { + "certFile": "./path/to/cert", + "certKey": "./path/to/key" + } +} +``` + +#### HTTPS min TLS version + +Minimum TLS version allowed. Accepted values are: `TLSv1.2`, `TLSv1.3`. Default is `TLSv1.2`. + +```json +{ + "service": { + "minTLSVersion": "TLSv1.2" + } +} +``` + #### Enable Prometheus metrics You can enable [Prometheus](https://prometheus.io/) metrics endpoint `/metrics` using the environment variable `ENABLE_METRICS`. Node.js and render request duration metrics are included, see [Enable Prometheus metrics endpoint]({{< relref "./monitoring#enable-prometheus-metrics-endpoint" >}}) for details.