moanos/RattenheimRechner
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Add Readme
All checks were successful
ci/woodpecker/push/woodpecker Pipeline was successful
Details

Browse Source
This commit is contained in:
moanos [he/him] 2024-07-18 20:25:48 +02:00
parent fc102e866c
commit 7e6d85d8a1
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# RattenheimRechner
Ein Rechner für die minimale Größe eines Rattenkäfigs nach Standard des [VdRD e.V.](https://vdrd.de)
## CI
CI runs via woodpecker. The following secrets should be set
| Key | Example | Description |
|------------|---------------------------------------|-------------------------------------------------------------------------------------------------|
| `host` | `static.example.org` | Hostename of the server where you want to deploy |
| `ssh_user` | `username` | User on the server |
| `ssh_key` | `-----BEGIN OPENSSH PRIVATE KEY-----` | The private SSH key of the user |
| `path` | `/path/to/be/deployed` | Path where to deploy the static files. Deploying means it'll create `public` in the given path. |