Skip to content
Cette page a été générée et traduite avec l'aide de l'IA. Si vous remarquez des inexactitudes, n'hésitez pas à contribuer. Modifier sur GitHub

prx gateway ​

Demarrer le serveur de passerelle HTTP/WebSocket en tant que processus autonome. Contrairement a prx daemon, cette commande ne demarre que la passerelle -- pas de canaux, de planificateur cron ni de moteur d'evolution.

Cela est utile pour les deploiements ou vous souhaitez exposer l'API PRX sans le daemon complet, ou lorsque vous executez les canaux et la planification en tant que processus separes.

Utilisation ​

bash
prx gateway [OPTIONS]

Options ​

DrapeauCourtDefautDescription
--config-c~/.config/prx/config.tomlChemin vers le fichier de configuration
--port-p3120Port d'ecoute
--host-H127.0.0.1Adresse de liaison
--log-level-linfoNiveau de verbosity des logs : trace, debug, info, warn, error
--cors-origin*Origines CORS autorisees (separees par des virgules)
--tls-certChemin vers le fichier de certificat TLS
--tls-keyChemin vers la cle privee TLS

Points de terminaison ​

La passerelle expose les groupes de points de terminaison suivants :

CheminMethodeDescription
/healthGETVerification de sante (retourne 200 OK)
/api/v1/chatPOSTEnvoyer un message de chat
/api/v1/chat/streamPOSTEnvoyer un message de chat (streaming SSE)
/api/v1/sessionsGET, POSTGestion des sessions
/api/v1/sessions/:idGET, DELETEOperations sur une session unique
/api/v1/toolsGETLister les outils disponibles
/api/v1/memoryGET, POSTOperations memoire
/wsWSPoint de terminaison WebSocket pour la communication en temps reel
/webhooks/:channelPOSTRecepteur de webhooks entrants pour les canaux

Consultez API HTTP de la passerelle et WebSocket de la passerelle pour la documentation complete de l'API.

Exemples ​

bash
# Demarrer sur le port par defaut
prx gateway

# Lier a toutes les interfaces sur le port 8080
prx gateway --host 0.0.0.0 --port 8080

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

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

# Journalisation debug
prx gateway --log-level debug

Derriere un proxy inverse ​

En production, placez la passerelle derriere un proxy inverse (Nginx, Caddy, etc.) pour la terminaison TLS et l'equilibrage de charge :

# Exemple Caddy
api.example.com {
    reverse_proxy localhost:3120
}
nginx
# Exemple Nginx
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;
    }
}

Signaux ​

SignalComportement
SIGHUPRecharger la configuration
SIGTERMArret gracieux (termine les requetes en cours)

Voir aussi ​

Released under the Apache-2.0 License.