From 7e6d85d8a1e7b290cb4d613ddeb57485840fbff9 Mon Sep 17 00:00:00 2001 From: moanos Date: Thu, 18 Jul 2024 20:25:48 +0200 Subject: [PATCH] docs: Add Readme --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e789737 --- /dev/null +++ b/README.md @@ -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. | +