Document remote backend deployment
This commit is contained in:
26
README.md
26
README.md
@@ -19,7 +19,7 @@ Web-Oberfläche für den **Neutral Search Crawler Tool (NSCT)** — eine Such- u
|
||||
│ └─────────────────────────────────────────┘ │
|
||||
└─────────────────────────────────────────────────────────────┘
|
||||
│
|
||||
▼ fetch
|
||||
▼ /api/*
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Proxy │
|
||||
│ ┌─────────────────────────────────────────────────────┐ │
|
||||
@@ -34,7 +34,7 @@ Web-Oberfläche für den **Neutral Search Crawler Tool (NSCT)** — eine Such- u
|
||||
┌─────────────────────────────────────────────────────────────┐
|
||||
│ Backend API │
|
||||
│ ┌─────────────────────────────────────────────────────┐ │
|
||||
│ │ NSCT Backend (Port 8080) │ │
|
||||
│ │ NSCT Backend auf separatem Rechner (z. B. :8080) │ │
|
||||
│ │ - /v1/research │ │
|
||||
│ │ - /v1/research/{id}/status │ │
|
||||
│ │ - /v1/research/{id} │ │
|
||||
@@ -51,7 +51,7 @@ Web-Oberfläche für den **Neutral Search Crawler Tool (NSCT)** — eine Such- u
|
||||
- **Error-System**: Stapelbare Toast-Notifications mit Auto-hide
|
||||
- **Error-Handling**: Polling bei COMPLETED/FAILED, onDestroy Cleanup
|
||||
- **Responsive Design**: Mobile-First mit TailwindCSS
|
||||
- **Docker Deployment**: Caddy Reverse-Proxy mit HTTPS, Healthchecks, Resource-Limits
|
||||
- **Docker Deployment**: Caddy Reverse-Proxy mit API-Weiterleitung, Healthchecks, Resource-Limits
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -68,19 +68,27 @@ npm run dev
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### Mit API-Key
|
||||
### Getrenntes Frontend- und Backend-Deployment
|
||||
|
||||
Setze die `NSCT_API_BASE_URL` Environment Variable für die Backend-Adresse:
|
||||
Frontend und Backend können auf unterschiedlichen Rechnern laufen. Der Browser
|
||||
spricht ausschließlich die Frontend-Domain unter `/api/*` an; Caddy leitet diese
|
||||
Anfragen an den Backend-Rechner weiter. Dadurch ist keine gemeinsame Docker-Bridge
|
||||
und keine Backend-CORS-Freigabe für den Browser erforderlich.
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```env
|
||||
# .env im Frontend-Repository; Host:Port, ohne http:// und ohne /api
|
||||
NSCT_API_UPSTREAM=backend.example.com:8080
|
||||
```
|
||||
|
||||
Der Backend-Rechner muss vom Frontend-Rechner auf dem angegebenen Port erreichbar
|
||||
sein. Für zwei Compose-Stacks auf demselben Rechner funktioniert der Default
|
||||
`host.docker.internal:8080`.
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Beschreibung | Default |
|
||||
|----------|-------------|---------|
|
||||
| `NSCT_API_BASE_URL` | Backend API URL | `http://localhost:8080` |
|
||||
| `NSCT_API_UPSTREAM` | Erreichbarer Backend-Host inklusive Port | `host.docker.internal:8080` |
|
||||
| `CADDY_DOMAIN` | Domain für HTTPS (Let's Encrypt) | keine (HTTP nur) |
|
||||
| `NSCT_RATE_LIMIT` | Rate-Limit Config für Caddy | keine |
|
||||
|
||||
@@ -116,4 +124,4 @@ Die Tests befinden sich im `tests/`-Verzeichnis:
|
||||
- SvelteKit Static Adapter (`adapter-static`)
|
||||
- Build Output: `build/`
|
||||
- Polling: Alle 5 Sekunden, stoppt bei COMPLETED/FAILED
|
||||
- Error-System: `ErrorBannerStore.ts` + `ErrorBanner.svelte` (stapelbar, auto-hide)
|
||||
- Error-System: `ErrorBannerStore.ts` + `ErrorBanner.svelte` (stapelbar, auto-hide)
|
||||
|
||||
Reference in New Issue
Block a user