Skip to content
This repository was archived by the owner on Aug 17, 2023. It is now read-only.

Commit 49d8d29

Browse files
committed
Document custom plugin environment variables.
1 parent c9a3d8f commit 49d8d29

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,16 @@ Deis output is a custom fluentd plugin that was written to forward data directly
4646
The topics these messages are put on are configurable via environment variables.
4747
* `NSQ_LOG_TOPIC`
4848
* `NSQ_METRIC_TOPIC`
49+
50+
### Custom Plugins
51+
If you need something beyond the plugins that come pre-installed in the image, it is possible to set some environment variables to install and configure custom plugins as well.
52+
53+
To install a custom plugin, simply set a FLUENTD_PLUGIN_# environment variable. For multiple plugins simply increment the trailing number.
54+
`FLUENTD_PLUGIN_1=some-fluentd-plugin`
55+
56+
To configure your custom plugins, use either the CUSTOM_STORE_# or CUSTOM_FILTER_# environment variables
57+
* `CUSTOM_STORE_1="configuration text"`
58+
* `CUSTOM_FILTER_1="configuration text"`
59+
60+
If you need the build tools available for installing your plugin, this can be enabled with another environment variable
61+
`INSTALL_BUILD_TOOLS="true"`

0 commit comments

Comments
 (0)