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

ci: Secret config
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
Details

Browse Source
This commit is contained in:
moanos [he/him]
2024-10-04 11:08:49 +02:00
parent 61cee697e4
commit 4ca5ed733c
2 changed files with 15 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/README.md
View File

@@ -86,4 +86,14 @@ docker run --rm -v ./docs:/docs sphinx-rtd make html
# CI
Woodpecker can be used to deploy the documentation to a server
Woodpecker can be used to deploy the documentation to a server. Fo that purpose it builds a docker container that contains
sphinx and the read-the-docs theme, builds the documentation with that and pushes it to a server which will serve the static files.
| Key | Example | Description |
|-------------------|-------------------------------------------------------------|-------------------------------------------------------------|
| `host` | `dokumentation.notfellchen.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` | `/static_sites/static-hyteck/dokumentation.notfellchen.org` | Path where to deploy the static files. |
| `docker_username` | `moanos` | Username authenticate to dockerhub to push the docker image |
| `docker_password` | `SUPERSECRET` | Password authenticate to dockerhub to push the docker image |