Forgejo Guardian

Simple Forgejo instance guardian, banning users and alerting admins based on certain regular expressions (regex)

Installation

You can let cargo build the binary for you, or build it yourself.

Build it

cargo-install

Tip

This will install the binary in ~/.cargo/bin/forgejo-guardian. Make sure to add this directory to your PATH. If you want to update it, run cargo install ... again.

cargo install --git https://git.4rs.nl/awiteb/forgejo-guardian

cargo-install (from source)

Tip

Then when you want to update it, pull the changes and run cargo install --path . again.

git clone https://git.4rs.nl/awiteb/forgejo-guardian
cd forgejo-guardian
cargo install --path .

Build (from source)

Tip

The binary will be in ./target/release/forgejo-guardian.

git clone https://git.4rs.nl/awiteb/forgejo-guardian
cd forgejo-guardian
cargo build --release

Configuration

We use TOML format for configuration, the default configuration file is /app/forgejo-guardian.toml, but you can specify a different one with FORGEJO_GUARDIAN_CONFIG environment variable.

Structure

In our configuration file, we have two main sections:

• forgejo: Forgejo instance configuration
• expressions: Regular expressions to match against

forgejo

Forgejo configuration section, with the following fields:

• instance_url: Forgejo instance URL (must be HTTPS or HTTP)
• token: Token to use to get the new users and ban them, requires read:admin and write:admin scopes.

[forgejo]
instance_url = "https://forgejo.example
token = "your-token"

expressions

Expressions configuration section, with the following fields:

• ban: Regular expressions to match against to ban the user
• sus: Regular expressions to match against to alert the admins

ban and sus are tables, and each one have the following fields:

• usernames: Regular expressions to match against the usernames
• full_names: Regular expressions to match against the full names
• biographies: Regular expressions to match against the biographies
• emails: Regular expressions to match against the emails
• websites: Regular expressions to match against the websites
• locations: Regular expressions to match against the locations

[expressions.ban]
usernames = ['^admin.*$']

[expressions.sus]
usernames = ['^mod.*$']