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

chore: Update README.md
All checks were successful
Write changelog / write-changelog (push) Successful in 25s
Details
Rust CI / Rust CI (push) Successful in 4m3s
Details

Browse source 
Signed-off-by: Awiteb <a@4rs.nl>
This commit is contained in:
Awiteb 2024-11-17 17:53:28 +00:00
parent cc2f8a791b
commit d59b4e6d3f
Signed by: awiteb
GPG key ID: 3F6B55640AA6682F
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -4,8 +4,8 @@
Simple Forgejo instance guardian, banning users and alerting admins based on certain regular expressions (regex) Simple Forgejo instance guardian, banning users and alerting admins based on certain regular expressions (regex)
<!-- [![Forgejo CI Status](https://git.4rs.nl/awiteb/forgejo-guardian/badges/workflows/ci.yml/badge.svg)](https://git.4rs.nl/awiteb/forgejo-guardian) [![Forgejo CI Status](https://git.4rs.nl/awiteb/forgejo-guardian/badges/workflows/ci.yml/badge.svg)](https://git.4rs.nl/awiteb/forgejo-guardian)
[![Forgejo CD Status](https://git.4rs.nl/awiteb/forgejo-guardian/badges/workflows/cd.yml/badge.svg)](https://git.4rs.nl/awiteb/forgejo-guardian) --> [![Forgejo CD Status](https://git.4rs.nl/awiteb/forgejo-guardian/badges/workflows/cd.yml/badge.svg)](https://git.4rs.nl/awiteb/forgejo-guardian)
[![agplv3-or-later](https://www.gnu.org/graphics/agplv3-88x31.png)](https://www.gnu.org/licenses/agpl-3.0.html) [![agplv3-or-later](https://www.gnu.org/graphics/agplv3-88x31.png)](https://www.gnu.org/licenses/agpl-3.0.html)
@ -13,7 +13,7 @@ Simple Forgejo instance guardian, banning users and alerting admins based on cer
## Installation ## Installation
You can let [cargo](https://doc.rust-lang.org/cargo/) build the binary for you, or build it yourself. <!-- You can also download the pre-built binaries from the [releases](https://git.4rs.nl/awiteb/forgejo-guardian/releases) page. --> You can let [cargo](https://doc.rust-lang.org/cargo/) build the binary for you, or build it yourself. You can also download the pre-built binaries from the [releases](https://git.4rs.nl/awiteb/forgejo-guardian/releases) page.
### Build it ### Build it
@ -97,9 +97,17 @@ Expressions configuration section, with the following fields:
- `websites`: Regular expressions to match against the websites - `websites`: Regular expressions to match against the websites
- `locations`: Regular expressions to match against the locations - `locations`: Regular expressions to match against the locations
Each field is an array of regular expressions, the regular expression can be one of the following:
- String: The regular expression itself
- Table: The regular expression and the reason, with the following fields:
- `re` (string, array of string): The regular expression (if it's an array of strings, all regex in that array should match to ban/sus the user)
- `reason` (optional string): The reason to ban/sus the user. This will be used in the notification message.
```toml ```toml
[expressions.ban] [expressions.ban]
usernames = ['^admin.*$'] usernames = ['^admin.*$']
websites = ['^https://example\.com$', { re = '^https://example2\.com$', reason = "Example 2 is not allowed" }, '^https://example3\.com$']
[expressions.sus] [expressions.sus]
usernames = ['^mod.*$'] usernames = ['^mod.*$']