awiteb/forgejo-guardian
0
Fork 0
Code Issues 1 Pull requests Releases 2 Activity Actions

chore: Update README.md

Browse source 
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb 2024-11-15 10:40:12 +00:00
parent 6070ca035c
commit 5344d742f6
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -55,12 +55,18 @@ We use `TOML` format for configuration, the default configuration file is `/app/
### Structure ### 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 - `forgejo`: Forgejo instance configuration
- `expressions`: Regular expressions to match against - `expressions`: Regular expressions to match against
- `telegram`: Telegram bot configuration - `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`
Forgejo configuration section, with the following fields: Forgejo configuration section, with the following fields:
@ -104,6 +110,7 @@ Telegram bot configuration section, with the following fields:
- `token`: Telegram bot token - `token`: Telegram bot token
- `chat`: Chat ID to send the alerts to (Can be a group or a channel or a user) - `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) - `lang`: Language to use for the alerts (Currently only `ar-sa`, `en-us` and `ru-ru` are supported)
```toml ```toml