Skip to content

Commit 4bdd4aa

Browse files
authored
Docs: v2.0.0 update (#138)
Removes IPv6 known issue. Removes environment variables. Adds configuration section. Closes #130
1 parent 3ad1228 commit 4bdd4aa

File tree

1 file changed

+2
-44
lines changed

1 file changed

+2
-44
lines changed

README.md

Lines changed: 2 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ However, [Chromium browser](https://www.chromium.org/) depends on certain librar
1717
system you may encounter errors when trying to render an image. For further details and troubleshooting help, please refer to
1818
[Grafana Image Rendering documentation](https://grafana.com/docs/administration/image_rendering/).
1919

20-
### Known issue having IPv6 disabled
21-
22-
We've got reports regarding the plugin doesn't work if IPv6 is disabled. The current workaround is to use [Remote Rendering Using Docker](#remote-rendering-using-docker) instead. Refer to [issue](https://github.com/grafana/grafana-image-renderer/issues/48) for more information.
23-
2420
## Installation
2521

2622
### Using grafana-cli
@@ -38,44 +34,10 @@ for rendering and using remote rendering, see [Remote Rendering Using Docker](#r
3834

3935
If you still want to install the plugin in the Grafana docker image we provide instructions for how to build a custom Grafana image, see [Grafana Docker documentation](https://grafana.com/docs/installation/docker/#custom-image-with-grafana-image-renderer-plugin-pre-installed) for further instructions.
4036

41-
### Environment variables
42-
43-
You can override certain settings by using environment variables and making sure that those are available for the Grafana process.
44-
45-
**Default timezone:**
46-
47-
Instruct headless browser instance to use a default timezone when not provided by Grafana, e.g. when rendering panel image of alert. See [ICU’s metaZones.txt](https://cs.chromium.org/chromium/src/third_party/icu/source/data/misc/metaZones.txt?rcl=faee8bc70570192d82d2978a71e2a615788597d1) for a list of supported timezone IDs. Fallbacks to `TZ` environment variable if not set.
48-
49-
```bash
50-
GF_RENDERER_PLUGIN_TZ=Europe/Stockholm
51-
```
52-
53-
**Ignore HTTPS errors:**
54-
55-
Instruct headless browser instance whether to ignore HTTPS errors during navigation. Per default HTTPS errors is not ignored.
56-
Due to the security risk it's not recommended to ignore HTTPS errors.
57-
58-
```bash
59-
GF_RENDERER_PLUGIN_IGNORE_HTTPS_ERRORS=true
60-
```
61-
62-
**gRPC port:**
63-
64-
Change the listening port of the gRPC server. Default is `0` and will automatically assign a port not in use.
65-
66-
```bash
67-
GF_RENDERER_PLUGIN_GRPC_PORT=50059
68-
```
69-
70-
**Verbose logging:**
71-
72-
Instruct headless browser instance whether to capture and log verbose information when rendering an image. Default is `false` and will only capture and log error messages. When enabled, `true`, debug messages are captured and logged as well.
7337

74-
For the verbose information to be included in the Grafana server log you have to adjust the rendering log level to `debug`, see [Troubleshoot image rendering](https://grafana.com/docs/grafana/latest/administration/image_rendering/#troubleshoot-image-rendering) for instructions.
38+
### Configuration
7539

76-
```bash
77-
GF_RENDERER_PLUGIN_VERBOSE_LOGGING=true
78-
```
40+
For available configuration settings, please refer to [Grafana Image Rendering documentation](https://grafana.com/docs/administration/image_rendering/).
7941

8042
## Remote Rendering Using Docker
8143

@@ -85,10 +47,6 @@ Instead of installing and running the image renderer as a plugin, you can run it
8547

8648
For troubleshooting help, please refer to [Grafana Image Rendering documentation](https://grafana.com/docs/administration/image_rendering/#troubleshooting).
8749

88-
## Building from source
89-
90-
See [Building from source](https://github.com/grafana/grafana-image-renderer/blob/master/docs/building_from_source.md).
91-
9250
## Additional information
9351

9452
See [docs](https://github.com/grafana/grafana-image-renderer/blob/master/docs/index.md).

0 commit comments

Comments
 (0)