docs: update README

This commit is contained in:
Marc 2024-11-05 22:23:43 -05:00
parent 9dc67bd9da
commit 07fcf89a60
Signed by: marc
GPG key ID: 048E042F22B5DC79

View file

@ -2,12 +2,18 @@
Forgejo instance serving https://forge.karnov.club. Forgejo instance serving https://forge.karnov.club.
## Maintaining ## Usage
### Starting the Forgejo instance
Using [spud](https://forge.karnov.club/spadinastan/spud), just `spud start ./service.yml`! Using [spud](https://forge.karnov.club/spadinastan/spud), just `spud start ./service.yml`!
### Starting runners ### Starting runners
Runner metadata (i.e. version, per-instance configuration) is defined under `metadata.json`.
Before starting the runners, they should be registered via `RUNNER_HOME=... ./runners.py register`. An interactive prompt needs to be filled for each runner to enter details and tokens.
``` ```
./runners.py start RUNNER_HOME=<path> ./runners.py start
``` ```