forgery/README.md

spam accounts management for forgejo

Usage

• remove model.json if you want to start with no pre-existing model of what is spam or not. Or keep it to use the current classifier. The file gets updated when using the tool: the classifier learns from spam/legit decisions and should get progressively better at identifying spam.
• run: cargo run
• classify users as spam/not spam. By default the classification is stored locally in db.json, no concrete action is taken. (see the ACTUALLY_BAN_USERS environment variable below.)

Configuration

Forgery reads the following environment variables:

• FORGEJO_URL: url of the forgejo instance (e.g. https://git.deuxfleurs.fr)
• FORGEJO_API_TOKEN: Forgejo API token granting admin access. Required. You can generate an API token using the Forgejo web interface in Settings -> Applications -> Generate New Token.
• ORG_NAME: organization name (used in the notification email sent when locking accounts)
• ADMIN_CONTACT_EMAIL: email that can be used to contact admins of your instance (included in the notification email sent when locking accounts)
• ACTUALLY_BAN_USERS: define it to true to actually lock user accounts, send notification emails and eventually delete user accounts. If not defined (the default) or set to false, no actual action is taken: spammers are only listed in the database. The variable should be set in production, but probably not for testing.
• STORAGE_BACKEND: either local (default) or s3. Chose local to store the application state to local files, or s3 to store them in S3-compatible storage (see below for corresponding configuration variables).

Environment variables read when ACTUALLY_BAN_USERS=true:

• SMTP_ADDRESS: address of the SMTP relay used to send email notifications
• SMTP_USERNAME: SMTP username
• SMTP_PASSWORD: SMTP password

Environment variables read when STORAGE_BACKEND=local:

• STORAGE_LOCAL_DIR: path to a local directory where to store the application data (as two files db.json and model.json). Defaults to . if not defined.

Environment variables read when STORAGE_BACKEND=s3:

• STORAGE_S3_BUCKET: name of the bucket where to store the application data (as two entries db.json and model.json).
• AWS_DEFAULT_REGION: S3 endpoint region
• AWS_ENDPOINT_URL: S3 endpoint URL
• AWS_ACCESS_KEY_ID: S3 key id
• AWS_SECRET_ACCESS_KEY: S3 key secret

Todos

• discuss the current design choices for when locking the account/sending a notification email fails. (Current behavior is to periodically retry, avoid deleting if the account could not be locked, but delete the account after the grace period even if the email could not be sent…)
• auth: add support for connecting to the forge using oauth?
• allow customizing the address & port on which to listen
• improve error handling