Tjenester og rute
Denne siden dekker hva Kanera-stakken kjører, hvilke deler som skal utsettes, og hvordan du setter en omvendt proxy foran dem.
Les det etterpå Komme i gang har en distribusjon som kjører, eller før du starter hvis du vil planlegge domener først.
Distribusjonsform
Standard komponere filen kjører disse tjenestene:
| Tjenester | Formål |
|---|---|
postgres | PostgreSQL database med vedvarende data i kanera_pgdata. |
valkey | Nødvendig Valkey-forekomst for sanntidsutvidelse, tilstedeværelse og delte satsgrenser. |
migrate | One-shot database migrering tjeneste som kjører før app-tjenester starter. |
api | Hoved Kanera API og sanntidsserver. |
worker | Enkelt bakgrunnsarbeider for planleggere, webhook levering, varsler, opprydding og sanntid utboks fallback. |
public-api | Offentlig integrasjon API. |
mcp | MCP Streamable HTTP-server støttet av det offentlige API. |
web | Bygget Kanera web app betjent av nginx. |
db-backup | Valgfritt kryptert PostgreSQL backup planlegger. |
Nettleseren skal koble til web ikke utsette hoved api direkte service; web nginx container proxyer app API og Socket.IO trafikk internt.
Expose public-api bare hvis du vil ha eksterne integrasjoner. Expose mcp Hvis du vil at eksterne MCP-klienter skal koble til over HTTP.
Anbefalte domener
Bruk separate domener for appen, offentlig API og MCP når du eksponerer alle tre:
| Domene | Tjenester | Bruk |
|---|---|---|
kanera.example.com | web | Kanera web app. |
api.kanera.example.com | public-api | REST API, webhooks og API referanse. |
mcp.kanera.example.com | mcp | Eksternt MCP-endepunkt for AI-klienter. |
De offentlige API- og MCP-domenene er valgfrie. Du kan starte med bare webappen og legge til de andre senere.
Publiser porter
Standard komponeringsfil holder tjenestene private. Hvis du kjører Docker direkte på en server, legg til en compose.override.yml fil:
services:
web:
ports:
- "8080:80"
public-api:
ports:
- "3001:3001"
mcp:
ports:
- "3002:3002"
Deretter peker du HTTPS-reverse proxy på:
| Offentlig URL | Oppstrøms |
|---|---|
https://kanera.example.com | http://127.0.0.1:8080 |
https://api.kanera.example.com | http://127.0.0.1:3001 |
https://mcp.kanera.example.com | http://127.0.0.1:3002 |
Bare publisere public-api og mcp Når du trenger dem.
Stol på proxy-innstillinger
Sett disse når Kanera står bak en pålitelig omvendt proxy som nginx, Traefik, Caddy eller en inntreden som sender den virkelige klient-IP:
API_TRUST_PROXY=true
PUBLIC_API_TRUST_PROXY=true
API_TRUST_PROXY hjelper app autentisering rate grenser bruke den virkelige klienten IP. PUBLIC_API_TRUST_PROXY Det samme gjelder for offentlige API-takstgrenser.
La dem være false bare når tjenesten er direkte Internett-vendt eller direkte Cloudflare-vendt.