44 lines
2 KiB
Markdown
44 lines
2 KiB
Markdown
# 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.
|
|
|
|
Environment variables that are relevant 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
|
|
|
|
## 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…)
|
|
- add backend to store data on garage instead of local files
|
|
- improve error handling
|