From 775aabc9e1a7e04f598bc0a405d94df2787308ad Mon Sep 17 00:00:00 2001 From: Johannes Przymusinski Date: Thu, 11 Aug 2022 21:53:10 +0200 Subject: [PATCH] docs: new configuration --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 9b96c56..e7033b8 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,23 @@ http://127.0.0.1:9101/probe?target=INBOX probe_mailbox_count 0 ``` +### Configuration + +The `imap-mailbox-exporter` can be configures with a `config.yaml` file and environment variables. + +```yaml +server: +- hostname: 'hostname' + port: '1234' + accounts: + - username: 'e@mail.com' + password: 'env:E_AT_MAIL_COM_PASSWORD' +``` + +You can use environment variables with the `env:VARIABLE_NAME` directive in YAML. + +The configuration file is expected in `./config.yaml` relative to the `imap-mailbox-exporter` binary. + ### Example Usage You can find a example docker compose configuration.