docs: update README
This commit is contained in:
parent
9dc67bd9da
commit
07fcf89a60
1 changed files with 8 additions and 2 deletions
10
README.md
10
README.md
|
@ -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
|
||||||
```
|
```
|
||||||
|
|
Loading…
Reference in a new issue