Armael/forgery
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

read the forgejo API token from an environment variable

Browse source
This commit is contained in:
Armaël Guéneau 2024-12-21 21:22:16 +01:00
parent 34ef744aeb
commit b56a54adff
2 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -2,20 +2,21 @@
## Usage ## Usage
- create an API token for your admin account, and write it in an `api_token`
file at the root of the repo
- remove `model.json` if you want to start with no pre-existing model of what is - 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 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 when using the tool: the classifier learns from spam/legit decisions and
should get progressively better at identifying spam. should get progressively better at identifying spam.
- run: `cargo run` - run: `cargo run`
- classify users as spam/not spam. Right now the classification is stored - classify users as spam/not spam. By default the classification is stored
locally in `db.json`, no concrete action is taken. (Ultimately we will want to locally in `db.json`, no concrete action is taken. (see the
lock/delete accounts, etc.) `ACTUALLY_BAN_USERS` environment variable below.)
## Configuration ## Configuration
Forgery reads the following environment variables: Forgery reads the following environment variables:
- `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`.
- `ACTUALLY_BAN_USERS`: define it (e.g. to `true`) to actually lock user - `ACTUALLY_BAN_USERS`: define it (e.g. to `true`) to actually lock user
accounts, send notification emails and eventually delete user accounts. If not accounts, send notification emails and eventually delete user accounts. If not
defined (the default), no actual action is taken, spammers are only listed in defined (the default), no actual action is taken, spammers are only listed in
@ -35,5 +36,4 @@ Environment variables that are relevant when `ACTUALLY_BAN_USERS=true`:
could not be locked, but delete the account after the grace period even if could not be locked, but delete the account after the grace period even if
the email could not be sent…) the email could not be sent…)
- add backend to store data on garage instead of local files - add backend to store data on garage instead of local files
- replate the `api_token` file with a better mechanism: oauth maybe?
- improve error handling - improve error handling

7
src/main.rs
View file

@ -1,4 +1,5 @@
use actix_web::{get, post, web, App, HttpRequest, HttpResponse, HttpServer, Responder}; use actix_web::{get, post, web, App, HttpRequest, HttpResponse, HttpServer, Responder};
use anyhow::Context;
use forgejo_api::{Auth, Forgejo}; use forgejo_api::{Auth, Forgejo};
use lazy_static::lazy_static; use lazy_static::lazy_static;
use rand::prelude::*; use rand::prelude::*;
@ -50,9 +51,9 @@ pub enum ActuallyBan {
} }
fn forge() -> anyhow::Result<Forgejo> { fn forge() -> anyhow::Result<Forgejo> {
let api_token = std::fs::read_to_string(Path::new("api_token"))? let api_token = std::env::var("FORGEJO_API_TOKEN")
.trim() .context("reading the FORGEJO_API_TOKEN environment variable")?;
.to_string();
let forge = Forgejo::new( let forge = Forgejo::new(
Auth::Token(&api_token), Auth::Token(&api_token),
url::Url::parse("https://git.deuxfleurs.fr")?, url::Url::parse("https://git.deuxfleurs.fr")?,