From 5344d742f6716c8c49a32a83183cadbea7adb893 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Fri, 15 Nov 2024 10:40:12 +0000 Subject: [PATCH] chore: Update `README.md` Signed-off-by: Awiteb --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b2dbc0..4161c60 100644 --- a/README.md +++ b/README.md @@ -55,12 +55,18 @@ We use `TOML` format for configuration, the default configuration file is `/app/ ### Structure -In our configuration file, we have three main sections: +In our configuration file you can have the following sections and the global sections: - `forgejo`: Forgejo instance configuration - `expressions`: Regular expressions to match against - `telegram`: Telegram bot configuration +#### Global sections + +The global section is the one that doesn't have a name, and it's in the top of the configuration file, with the following fields: + +- `dry_run`: If set to `true`, the guardian will not ban the users, but will only alert the admins (default: `false`) + #### `forgejo` Forgejo configuration section, with the following fields: @@ -104,6 +110,7 @@ Telegram bot configuration section, with the following fields: - `token`: Telegram bot token - `chat`: Chat ID to send the alerts to (Can be a group or a channel or a user) +- `ban_alert`: Send a notification when a user is banned (default: `false`) - `lang`: Language to use for the alerts (Currently only `ar-sa`, `en-us` and `ru-ru` are supported) ```toml