Deployment-Konventionen und Projektvorlagen
DEPLOY.md beschreibt, wie ein Container aussehen muss, damit er mit dem Runner und dem Nginx Proxy Manager zusammenspielt: fester Projektname, Image mit Versionstag, kein ports-Mapping, Healthcheck als Deploy-Gate, named volumes statt relativer Bind-Mounts. bootstrap.sh holt die Vorlagen per curl in ein neues Projekt und ersetzt __APP__ und __PORT__. Vorhandene Dateien bleiben unangetastet. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
49
README.md
Normal file
49
README.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# deploy-kit
|
||||
|
||||
Vorlagen und Konventionen fuer Apps, die auf dem VPS per Tag-Push deployt
|
||||
werden. Der Runner selbst liegt in
|
||||
[gitea-runner](https://gitea.lucas-orth.de/lucas.orth/gitea-runner).
|
||||
|
||||
## In ein neues Projekt holen
|
||||
|
||||
```bash
|
||||
curl -fsSL https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/bootstrap.sh | sh -s -- <app-name> <port>
|
||||
```
|
||||
|
||||
Oder erst herunterladen und ansehen, dann ausfuehren:
|
||||
|
||||
```bash
|
||||
curl -fsSLO https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/bootstrap.sh && sh bootstrap.sh <app-name> <port>
|
||||
```
|
||||
|
||||
Das Skript legt an, was fehlt, und laesst Vorhandenes unangetastet:
|
||||
|
||||
| Datei | Zweck |
|
||||
|---|---|
|
||||
| `DEPLOY.md` | Die Konventionen. Fuer dich und fuer Claude. |
|
||||
| `docker-compose.yml` | Projektname, Image-Tag, Web-Netz, Healthcheck |
|
||||
| `.gitea/workflows/deploy.yml` | Tag `v*` -> Build -> Test -> Deploy |
|
||||
| `.dockerignore` | |
|
||||
| `Dockerfile` | Node-Vorlage, pro Projekt anzupassen |
|
||||
|
||||
`__APP__` und `__PORT__` werden dabei ersetzt.
|
||||
|
||||
## Nur die Konventionen
|
||||
|
||||
Wenn ein Projekt schon eingerichtet ist und du nur die aktuelle Fassung der
|
||||
Regeln brauchst:
|
||||
|
||||
```bash
|
||||
curl -fsSL -o DEPLOY.md https://gitea.lucas-orth.de/lucas.orth/deploy-kit/raw/branch/main/DEPLOY.md
|
||||
```
|
||||
|
||||
## Sichtbarkeit
|
||||
|
||||
Das Repo muss oeffentlich sein, damit `curl` ohne Umstaende funktioniert.
|
||||
Es enthaelt keine Secrets - aber es beschreibt die Infrastruktur
|
||||
(Domains, Netznamen, Containernamen). Wenn dir das zu viel ist, stell es auf
|
||||
privat und setze beim Bootstrap ein Token:
|
||||
|
||||
```bash
|
||||
DEPLOY_KIT_TOKEN=<gitea-pat-mit-read-scope> sh bootstrap.sh <app-name> <port>
|
||||
```
|
||||
Reference in New Issue
Block a user