Module comments, update example config

This commit is contained in:
Pascal Engélibert 2026-07-31 21:23:09 +02:00
commit d97184cd51
9 changed files with 52 additions and 6 deletions

View file

@ -27,8 +27,19 @@ Early development: not usable yet.
* [ ] Error pages
* [ ] Webdesign
* [ ] Compatibility with other forges
* [ ] Serve at a subdirectory
* [ ] Better logo (contribution welcome)
## Install
Use `example_config.toml`. The settings that are important to look at are `listen_host`, `listen_port`, `data_dir`, `api_client_user_agent` and `origin`.
The executable is self-contained. Serve it behind any reverse proxy. The process must have read/write access to `data_dir`, where the repositories will be stored.
```bash
blindforge config.toml
```
## Design choices
**Language**: It would have been simpler to use good old PHP and SQL. But I have more fun with Rust.