Skip to content
Diese Seite wurde mit KI-Unterstützung erstellt und übersetzt. Falls Ihnen Ungenauigkeiten auffallen, helfen Sie gerne bei der Verbesserung. Auf GitHub bearbeiten

Konfigurationsreferenz

OpenPR wird über Umgebungsvariablen konfiguriert. Alle Dienste lesen aus derselben .env-Datei bei Verwendung von Docker Compose oder aus einzelnen Umgebungsvariablen bei direktem Betrieb.

API-Server

VariableStandardBeschreibung
APP_NAMEapiAnwendungsbezeichner für Protokollierung
BIND_ADDR0.0.0.0:8080Adresse und Port, auf dem die API lauscht
DATABASE_URL--PostgreSQL-Verbindungszeichenfolge
JWT_SECRETchange-me-in-productionGeheimschlüssel zum Signieren von JWT-Tokens
JWT_ACCESS_TTL_SECONDS2592000 (30 Tage)Zugriffstoken-Lebensdauer in Sekunden
JWT_REFRESH_TTL_SECONDS604800 (7 Tage)Aktualisierungstoken-Lebensdauer in Sekunden
RUST_LOGinfoProtokollstufe (trace, debug, info, warn, error)
UPLOAD_DIR/app/uploadsVerzeichnis für Datei-Uploads

Sicherheit

JWT_SECRET immer auf einen starken, zufälligen Wert in der Produktion ändern. Mindestens 32 Zeichen zufälliger Daten verwenden:

bash
openssl rand -hex 32

Datenbank

VariableStandardBeschreibung
DATABASE_URL--Vollständige PostgreSQL-Verbindungszeichenfolge
POSTGRES_DBopenprDatenbankname
POSTGRES_USERopenprDatenbankbenutzer
POSTGRES_PASSWORDopenprDatenbankpasswort

Format der Verbindungszeichenfolge:

postgres://user:password@host:port/database

Docker Compose

Bei Verwendung von Docker Compose heißt der Datenbankdienst postgres, also lautet die Verbindungszeichenfolge:

postgres://openpr:openpr@postgres:5432/openpr

Worker

VariableStandardBeschreibung
APP_NAMEworkerAnwendungsbezeichner
DATABASE_URL--PostgreSQL-Verbindungszeichenfolge
JWT_SECRET--Muss mit dem API-Server-Wert übereinstimmen
RUST_LOGinfoProtokollstufe

Der Worker verarbeitet Hintergrundaufgaben aus den Tabellen job_queue und scheduled_jobs.

MCP-Server

VariableStandardBeschreibung
APP_NAMEmcp-serverAnwendungsbezeichner
OPENPR_API_URL--API-Server-URL (einschließlich Proxy, falls zutreffend)
OPENPR_BOT_TOKEN--Bot-Token mit opr_-Präfix
OPENPR_WORKSPACE_ID--Standard-Arbeitsbereichs-UUID
DATABASE_URL--PostgreSQL-Verbindungszeichenfolge
JWT_SECRET--Muss mit dem API-Server-Wert übereinstimmen
DEFAULT_AUTHOR_ID--Fallback-Autor-UUID für MCP-Operationen
RUST_LOGinfoProtokollstufe

MCP-Transport-Optionen

Das MCP-Server-Binary akzeptiert Befehlszeilenargumente:

bash
# HTTP-Modus (Standard)
mcp-server --transport http --bind-addr 0.0.0.0:8090

# stdio-Modus (für Claude Desktop, Codex)
mcp-server --transport stdio

# Unterbefehlsform
mcp-server serve --transport http --bind-addr 0.0.0.0:8090

Frontend

VariableStandardBeschreibung
VITE_API_URLhttp://localhost:8080API-Server-URL, mit der sich das Frontend verbindet

Reverse-Proxy

In der Produktion mit einem Reverse-Proxy (Caddy/Nginx) sollte VITE_API_URL auf die Proxy-URL zeigen, die zum API-Server weiterleitet.

Docker-Compose-Ports

DienstInterner PortExterner PortZweck
PostgreSQL54325432Datenbank
API80808081REST-API
Worker----Hintergrundaufgaben (kein Port)
MCP-Server80908090MCP-Tools
Frontend803000Web-UI

Beispiel-.env-Datei

bash
# Database
DATABASE_URL=postgres://openpr:openpr@localhost:5432/openpr
POSTGRES_DB=openpr
POSTGRES_USER=openpr
POSTGRES_PASSWORD=openpr

# JWT (CHANGE IN PRODUCTION)
JWT_SECRET=change-me-in-production
JWT_ACCESS_TTL_SECONDS=2592000
JWT_REFRESH_TTL_SECONDS=604800

# API Server
APP_NAME=api
BIND_ADDR=0.0.0.0:8080
RUST_LOG=info

# Frontend
VITE_API_URL=http://localhost:8080

# MCP Server
MCP_SERVER_PORT=8090

Protokollstufen

OpenPR verwendet das tracing-Crate für strukturierte Protokollierung. RUST_LOG setzen, um die Ausführlichkeit zu steuern:

StufeBeschreibung
errorNur Fehler
warnFehler und Warnungen
infoNormale Betriebsmeldungen (Standard)
debugDetaillierte Debugging-Informationen
traceSehr ausführlich, enthält alle internen Operationen

Modulspezifische Filterung wird unterstützt:

bash
RUST_LOG=info,api=debug,mcp_server=trace

Nächste Schritte

Released under the Apache-2.0 License.