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

prx gateway

Startet den HTTP/WebSocket-Gateway-Server als eigenständigen Prozess. Anders als prx daemon startet dieser Befehl nur das Gateway -- keine Kanäle, keinen Cron-Scheduler und keine Entwicklungs-Engine.

Dies ist nützlich für Bereitstellungen, bei denen Sie die PRX-API verfügbar machen möchten, ohne den vollständigen Daemon, oder wenn Sie Kanäle und Scheduling als separate Prozesse ausführen.

Verwendung

bash
prx gateway [OPTIONS]

Optionen

FlagKurzStandardBeschreibung
--config-c~/.config/prx/config.tomlPfad zur Konfigurationsdatei
--port-p3120Lauschport
--host-H127.0.0.1Bindungsadresse
--log-level-linfoLog-Ausführlichkeit: trace, debug, info, warn, error
--cors-origin*Erlaubte CORS-Ursprünge (kommagetrennt)
--tls-certPfad zur TLS-Zertifikatsdatei
--tls-keyPfad zur TLS-Privatschlüsseldatei

Endpunkte

Das Gateway stellt folgende Endpunktgruppen bereit:

PfadMethodeBeschreibung
/healthGETGesundheitscheck (gibt 200 OK zurück)
/api/v1/chatPOSTChat-Nachricht senden
/api/v1/chat/streamPOSTChat-Nachricht senden (Streaming SSE)
/api/v1/sessionsGET, POSTSitzungsverwaltung
/api/v1/sessions/:idGET, DELETEEinzelne Sitzungsoperationen
/api/v1/toolsGETVerfügbare Werkzeuge auflisten
/api/v1/memoryGET, POSTGedächtnisoperationen
/wsWSWebSocket-Endpunkt für Echtzeitkommunikation
/webhooks/:channelPOSTEingehender Webhook-Empfänger für Kanäle

Siehe Gateway HTTP-API und Gateway WebSocket für die vollständige API-Dokumentation.

Beispiele

bash
# Auf Standardport starten
prx gateway

# An alle Schnittstellen auf Port 8080 binden
prx gateway --host 0.0.0.0 --port 8080

# Mit TLS
prx gateway --tls-cert /etc/prx/cert.pem --tls-key /etc/prx/key.pem

# CORS einschränken
prx gateway --cors-origin "https://app.example.com,https://admin.example.com"

# Debug-Logging
prx gateway --log-level debug

Hinter einem Reverse-Proxy

In der Produktion platzieren Sie das Gateway hinter einem Reverse-Proxy (Nginx, Caddy usw.) für TLS-Terminierung und Lastverteilung:

# Caddy-Beispiel
api.example.com {
    reverse_proxy localhost:3120
}
nginx
# Nginx-Beispiel
server {
    listen 443 ssl;
    server_name api.example.com;

    location / {
        proxy_pass http://127.0.0.1:3120;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "upgrade";
        proxy_set_header Host $host;
    }
}

Signale

SignalVerhalten
SIGHUPKonfiguration neu laden
SIGTERMOrdnungsgemäßes Herunterfahren (beendet laufende Anfragen)

Verwandte Themen

Released under the Apache-2.0 License.