Files
Speech/docs/deployment.md
T
2026-06-07 22:20:57 +00:00

156 lines
4.0 KiB
Markdown

# Deployment
## VPS Deployment
```bash
docker compose up --build -d
```
Services:
- Web: intern `speech-web:80`, oeffentlich nur ueber Caddy
- API: intern `speech-api:8080`, oeffentlich nur ueber Caddy `/api`
- PostgreSQL: nur internes Docker-Netz
- Redis: nur internes Docker-Netz
- Flowise: vorhandene Instanz ueber `FLOWISE_BASE_URL`
## Lokale Entwicklung
```bash
cp .env.example .env
docker compose -f docker-compose.dev.yml up --build -d
```
Lokale Ports:
- Web: `5173`
- API: `8080`
- Flowise: `3000`
- PostgreSQL: `5432`
- Redis: `6379`
## Production Notes
- Change `APP_JWT_SECRET`.
- Set strong Flowise credentials.
- Restrict exposed database/Redis ports or remove public port mappings.
- Put a reverse proxy with TLS in front of web/API/Flowise.
- Set `AZURE_ENABLE_MOCK=false` only after configuring Azure credentials.
- Add backups for PostgreSQL and Flowise volume.
## VPS mit bestehendem Caddy, CrowdSec und WireGuard
Fuer deinen VPS ist die Default-Variante `docker-compose.yml`. `docker-compose.prod.yml` bleibt als identische explizite Produktionsdatei erhalten.
Annahmen:
- Caddy laeuft bereits in Docker.
- Caddy ist der einzige oeffentliche HTTP/HTTPS-Einstieg.
- CrowdSec + nftables Bouncer schuetzen die oeffentlichen Ports.
- Dein Arbeits-PC ist per WireGuard erreichbar, z. B. ueber `10.8.0.0/24`.
Setup:
```bash
docker compose up --build -d
```
Dann den Inhalt aus `deploy/caddy/speech.Caddyfile` in `/srv/docker/caddy/Caddyfile` einfuegen und Caddy neu laden.
Wichtig:
- `speech-web` und `speech-api` haengen am externen Docker-Netzwerk von Caddy.
- Auf deinem VPS ist das passende Caddy-Netzwerk `web`; setze also `CADDY_DOCKER_NETWORK=web`.
- PostgreSQL und Redis haben keine Host-Port-Freigabe.
- Die API ist nur ueber `https://speech.v2202510301049387828.goodsrv.de/api` erreichbar.
- Flowise wird standardmaessig wiederverwendet: `FLOWISE_BASE_URL=http://flowise:3000`.
- Wenn dein Caddy-Netzwerk anders heisst, `CADDY_DOCKER_NETWORK` in `.env` anpassen.
Das echte Caddy-Netzwerk findest du auf dem VPS mit:
```bash
docker inspect caddy-caddy-1 --format '{{json .NetworkSettings.Networks}}'
```
Bei dir stehen `monitoring_default` und `web`. Fuer Speech nimm `web`:
```env
CADDY_DOCKER_NETWORK=web
```
Wenn der Flowise-Hostname im Caddy-Netzwerk nicht `flowise` ist, pruefen:
```bash
docker inspect flowise-main --format '{{json .NetworkSettings.Networks}}'
```
Dann `FLOWISE_BASE_URL` entsprechend setzen, z. B.:
```env
FLOWISE_BASE_URL=http://flowise-main:3000
```
Wegen deiner laufenden Container werden in der Produktions-Compose bewusst keine Host-Ports fuer Speech veroeffentlicht. Dadurch gibt es keine Kollision mit:
- Caddy: `80`, `443`
- Grafana: `127.0.0.1:3000`
- Prometheus: `127.0.0.1:9090`
- Adminer: `10.8.0.1:8080`
- Gitea SSH: `2222`
- Qdrant: `6333-6334`
- vorhandenen PostgreSQL/Redis/Flowise-internen Ports
Falls du doch eine dedizierte Flowise-Instanz fuer Speech willst:
```bash
docker compose -f docker-compose.yml -f docker-compose.flowise.yml up --build -d
```
Auch diese Variante publiziert keine Host-Ports.
Empfohlen fuer dein bestehendes Flowise: Ersetze den vorhandenen `flowise.v220...` Caddy-Block optional durch `deploy/caddy/flowise-wireguard-only.Caddyfile`, damit Flowise nur noch ueber WireGuard erreichbar ist.
Minimaler Caddy-Reload:
```bash
docker exec caddy caddy validate --config /etc/caddy/Caddyfile
docker exec caddy caddy reload --config /etc/caddy/Caddyfile
```
## Debugmodus
Der Debugmodus wird ueber `.env` gesteuert:
```env
DEBUG_ENABLED=true
DEBUG_VERBOSE=false
LOG_LEVEL=debug
```
Nach einer Aenderung muss die API neu erzeugt/gestartet werden:
```bash
docker compose up -d --force-recreate speech-api
```
Debug ist nur fuer eingeloggte Nutzer erreichbar. Die Frontend-Navigation zeigt dann einen Punkt `Debug`. Die API-Endpunkte liegen intern unter:
- `/api/debug/status`
- `/api/debug/db`
- `/api/debug/flowise`
- `/api/debug/azure`
- `/api/debug/runtime`
Wieder deaktivieren:
```env
DEBUG_ENABLED=false
LOG_LEVEL=info
```
Danach erneut:
```bash
docker compose up -d --force-recreate speech-api
```