docs: add readme

This commit is contained in:
Orion Kindel 2023-05-21 13:08:06 -05:00
parent ae4ef7d1f6
commit 32bb3ca3a3
Signed by untrusted user who does not match committer: orion
GPG Key ID: 6D4165AE4C928719

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# srv
## principles
* strong security
* fine-grained user-based access and security
* rootless docker
* user-space systemctl for scheduled tasks
* re-runnable and idempotent; changes to configuration does the same work as initial setup without losing state
## observable outputs
* given gitea domain `<git_url>`:
* configures ssl for `https://<git_url>`
* forwards `http://<git_url>` -> `https://<git_url>`
* `https://<git_url>` serves gitea instance using sqlite3
* SSH git authentication via `git@<git_url>` is fully supported
* gitea has actions enabled and a runner instance provided
* any gitea instance data and sessions are preserved (_Note: the linux user that "owns" the gitea instance was deleted and recreated, and configuration was overwritten by `src/gitea-app.ini`._)
## setup
copy `src/gitea-app.ini.sample` to `src/gitea-app.ini` and fill in the `; <snip>` secrets
## running
copy this repository to the debian image, ex with sshfs:
```sh
> mkdir ./ext
> sshfs user@host:/mnt ./ext
> rm ./ext/*; cp ./src/* ./ext/ # <- effectively deploys new configuration
```
then on the host run `/mnt/000-entry.sh` in an interactive shell.