Skip to content

Commit

Permalink
add a note about reloading the configuration when running within dock…
Browse files Browse the repository at this point in the history
…er (honeycombio#448)

Co-authored-by: Mike Goldsmith <[email protected]>
  • Loading branch information
leviwilson and MikeGoldsmith authored May 9, 2022
1 parent 7d3faf7 commit 011c8f7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,9 @@ There are a few vital configuration options; read through this list and make sur

There are a few components of Refinery with multiple implementations; the config file lets you choose which you'd like. As an example, there are two logging implementations - one that uses `logrus` and sends logs to STDOUT and a `honeycomb` implementation that sends the log messages to a Honeycomb dataset instead. Components with multiple implementations have one top level config item that lets you choose which implementation to use and then a section further down with additional config options for that choice (for example, the Honeycomb logger requires an API key).

When configuration changes, Refinery will automatically reload the configuration.
When configuration changes, Refinery will automatically reload the configuration[^1].

[^1]: When running Refinery within docker, be sure to mount the directory containing configuration & rules files so that [reloading will work](https://github.com/spf13/viper/issues/920) as expected.

### Redis-based Peer Management

Expand Down

0 comments on commit 011c8f7

Please sign in to comment.