Update README.md to reflect new Docker image publishing and CI/CD workflow
- Enhance documentation with details on automatic image builds and pushes to Gitea Container Registry. - Add instructions for pulling and running the container image, including usage in docker-compose. - Include information on the CI/CD workflow for building and pushing images based on version tags.
This commit is contained in:
57
README.md
57
README.md
@@ -7,8 +7,8 @@ Produktionsnahes internes Tool zur Erstellung von Thomas-Krenn.AG Newslettern au
|
|||||||
- Login und Benutzerverwaltung mit RBAC (`admin`, `editor`, `reader`)
|
- Login und Benutzerverwaltung mit RBAC (`admin`, `editor`, `reader`)
|
||||||
- Verpflichtender CSRF-Schutz auf allen POST-Formularen
|
- Verpflichtender CSRF-Schutz auf allen POST-Formularen
|
||||||
- Filter in der Web-UI:
|
- Filter in der Web-UI:
|
||||||
- Zeitraum in Tagen
|
- Zeitraum in Tagen oder „Letzter Monat“
|
||||||
- Nur bearbeitete Artikel
|
- Artikel-Auswahl: alle, nur neue oder nur bearbeitete Artikel
|
||||||
- Kategorie
|
- Kategorie
|
||||||
- Redaktioneller Feinschliff pro Ausgabe:
|
- Redaktioneller Feinschliff pro Ausgabe:
|
||||||
- **Redaktionsnotiz** – optionaler Hinweistext, der als eigene Box im Newsletter erscheint
|
- **Redaktionsnotiz** – optionaler Hinweistext, der als eigene Box im Newsletter erscheint
|
||||||
@@ -25,7 +25,7 @@ Produktionsnahes internes Tool zur Erstellung von Thomas-Krenn.AG Newslettern au
|
|||||||
- Verteilerlisten
|
- Verteilerlisten
|
||||||
- tägliche Zeitplanung
|
- tägliche Zeitplanung
|
||||||
- Versandprotokoll
|
- Versandprotokoll
|
||||||
- Docker/Compose Betrieb
|
- Docker/Compose Betrieb, inkl. automatischem Image-Build & Push in die Gitea Container Registry (per Versions-Tag)
|
||||||
|
|
||||||
## Start mit Docker
|
## Start mit Docker
|
||||||
|
|
||||||
@@ -50,6 +50,57 @@ Produktionsnahes internes Tool zur Erstellung von Thomas-Krenn.AG Newslettern au
|
|||||||
4. Zugriff:
|
4. Zugriff:
|
||||||
- [http://localhost:8080/login](http://localhost:8080/login) (oder dein `HOST_PORT`)
|
- [http://localhost:8080/login](http://localhost:8080/login) (oder dein `HOST_PORT`)
|
||||||
|
|
||||||
|
## Container-Image (Gitea Packages)
|
||||||
|
|
||||||
|
Fertige Images werden automatisch in die Gitea Container Registry veröffentlicht:
|
||||||
|
|
||||||
|
```
|
||||||
|
git.hexahost.dev/smueller/tk-wiki-newsletter
|
||||||
|
```
|
||||||
|
|
||||||
|
Verfügbare Tags: `latest`, die Version (`X.Y.Z`, `X.Y`, `X`) sowie der kurze Commit-SHA.
|
||||||
|
|
||||||
|
Image ziehen und mit vorhandener `.env` starten:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker login git.hexahost.dev
|
||||||
|
docker pull git.hexahost.dev/smueller/tk-wiki-newsletter:latest
|
||||||
|
docker run -d --name tk-newsletter-admin \
|
||||||
|
--env-file .env \
|
||||||
|
-p 8080:8000 \
|
||||||
|
-v newsletter_data:/app/data \
|
||||||
|
git.hexahost.dev/smueller/tk-wiki-newsletter:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
Alternativ in `docker-compose.yml` statt `build: .` das Image referenzieren:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
services:
|
||||||
|
newsletter-admin:
|
||||||
|
image: git.hexahost.dev/smueller/tk-wiki-newsletter:latest
|
||||||
|
# build: . # <- nicht mehr nötig, wenn das fertige Image genutzt wird
|
||||||
|
```
|
||||||
|
|
||||||
|
### Automatischer Build (CI/CD)
|
||||||
|
|
||||||
|
Der Workflow `.gitea/workflows/docker-build.yml` baut und pusht das Image über Gitea Actions.
|
||||||
|
|
||||||
|
- **Auslöser**: nur beim Setzen eines Versions-Tags `v*` (kein Build bei normalen Pushes auf `dev`/`main`).
|
||||||
|
- **Release-Ablauf** (Build bei Merge `dev` → `main` mit Version):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git checkout main
|
||||||
|
git merge --no-ff dev
|
||||||
|
git push origin main
|
||||||
|
git tag v1.0.0
|
||||||
|
git push origin v1.0.0 # <- startet Build & Push
|
||||||
|
```
|
||||||
|
|
||||||
|
- **Benötigte Repo-Secrets** (Settings → Actions → Secrets):
|
||||||
|
- `REGISTRY_TOKEN`: Gitea Access-Token mit Scope **Package: Read and write**
|
||||||
|
- `REGISTRY_USER` (optional): Registry-Benutzername, falls abweichend vom Repo-Owner
|
||||||
|
- **Optionale Repo-Variable**: `REGISTRY`, um den Registry-Host zu überschreiben (Default `git.hexahost.dev`).
|
||||||
|
|
||||||
## Sicherheits-Hinweise für Produktion
|
## Sicherheits-Hinweise für Produktion
|
||||||
|
|
||||||
- Reverse Proxy (z. B. Nginx/Traefik) mit TLS vor den Container setzen.
|
- Reverse Proxy (z. B. Nginx/Traefik) mit TLS vor den Container setzen.
|
||||||
|
|||||||
Reference in New Issue
Block a user