Skip to content
Esta página fue generada y traducida con asistencia de IA. Si encuentra alguna imprecisión, no dude en ayudar a mejorarla. Editar en GitHub

prx gateway

Inicia el servidor gateway HTTP/WebSocket como un proceso independiente. A diferencia de prx daemon, este comando solo inicia el gateway -- sin canales, programador cron ni motor de evolucion.

Esto es util para despliegues donde quieres exponer la API de PRX sin el demonio completo, o cuando ejecutas los canales y la programacion como procesos separados.

Uso

bash
prx gateway [OPTIONS]

Opciones

OpcionCortaPor defectoDescripcion
--config-c~/.config/prx/config.tomlRuta al archivo de configuracion
--port-p3120Puerto de escucha
--host-H127.0.0.1Direccion de enlace
--log-level-linfoVerbosidad del log: trace, debug, info, warn, error
--cors-origin*Origenes CORS permitidos (separados por comas)
--tls-certRuta al archivo de certificado TLS
--tls-keyRuta al archivo de clave privada TLS

Endpoints

El gateway expone los siguientes grupos de endpoints:

RutaMetodoDescripcion
/healthGETComprobacion de salud (devuelve 200 OK)
/api/v1/chatPOSTEnviar un mensaje de chat
/api/v1/chat/streamPOSTEnviar un mensaje de chat (streaming SSE)
/api/v1/sessionsGET, POSTGestion de sesiones
/api/v1/sessions/:idGET, DELETEOperaciones sobre una sesion individual
/api/v1/toolsGETListar herramientas disponibles
/api/v1/memoryGET, POSTOperaciones de memoria
/wsWSEndpoint WebSocket para comunicacion en tiempo real
/webhooks/:channelPOSTReceptor de webhooks entrantes para canales

Consulta API HTTP del Gateway y WebSocket del Gateway para la documentacion completa de la API.

Ejemplos

bash
# Iniciar en el puerto por defecto
prx gateway

# Enlazar a todas las interfaces en el puerto 8080
prx gateway --host 0.0.0.0 --port 8080

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

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

# Logging de depuracion
prx gateway --log-level debug

Detras de un proxy inverso

En produccion, coloca el gateway detras de un proxy inverso (Nginx, Caddy, etc.) para terminacion TLS y balanceo de carga:

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

Senales

SenalComportamiento
SIGHUPRecargar configuracion
SIGTERMApagado ordenado (finaliza las solicitudes en curso)

Relacionado

Released under the Apache-2.0 License.