From c2bd8de5fbe3753bb623f286605086f2defd11e7 Mon Sep 17 00:00:00 2001 From: "Max R. Carrara" Date: Mon, 10 Mar 2025 23:34:00 +0100 Subject: [PATCH] readme: document known env vars Signed-off-by: Max R. Carrara --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index a6c6ec7..7baf5e0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,12 @@ # stammtisch-bot +## Environment Variables + +| Name | Options | Default | Description | +| --------------- | --------------- | --------------- | --------------- | +| `BOT_LOG_LEVEL` | `NOTSET`, `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL` | `INFO` | The bot's log level. Corresponds to [Python log levels](https://docs.python.org/3/library/logging.html#logging-levels) | +| `BOT_MEMORY_DB` | `0` or `1` | `0` | When enabled, the database will reside in memory when the bot is started. This is useful for a debugging or testing instance. | +| `BOT_OWNER_ID` | `int` or `None` | `None` | The ID of the bot's owner. Should usually the person running the bot. | +| `BOT_PREFIX` | any string without whitespace | `!` | The prefix the bot will use for commands. | +| `BOT_TOKEN_FILE` | any valid filepath | `./token.txt` | A file containing the bot token. Will be read on startup. | +