aequitosh/stammtisch-bot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme: document known env vars

Browse source 
Signed-off-by: Max R. Carrara <max@aequito.sh>
This commit is contained in:
Max R. Carrara 2025-03-10 23:34:00 +01:00
parent b2af736ae0
commit c2bd8de5fb
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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. |