Skip to content
Эта страница создана и переведена с помощью ИИ. Если вы заметили неточности, помогите нам улучшить её. Редактировать на GitHub

prx gateway

Запуск HTTP/WebSocket шлюзового сервера как автономного процесса. В отличие от prx daemon, эта команда запускает только шлюз — без каналов, планировщика cron и движка эволюции.

Это полезно для развёртываний, где вы хотите предоставить API PRX без полного демона, или когда каналы и планирование запускаются как отдельные процессы.

Использование

bash
prx gateway [OPTIONS]

Параметры

ФлагСокр.По умолчаниюОписание
--config-c~/.config/prx/config.tomlПуть к файлу конфигурации
--port-p3120Порт прослушивания
--host-H127.0.0.1Адрес привязки
--log-level-linfoУровень детализации логов: trace, debug, info, warn, error
--cors-origin*Разрешённые CORS-источники (через запятую)
--tls-certПуть к файлу TLS-сертификата
--tls-keyПуть к файлу закрытого TLS-ключа

Эндпоинты

Шлюз предоставляет следующие группы эндпоинтов:

ПутьМетодОписание
/healthGETПроверка состояния (возвращает 200 OK)
/api/v1/chatPOSTОтправка сообщения чата
/api/v1/chat/streamPOSTОтправка сообщения чата (потоковый SSE)
/api/v1/sessionsGET, POSTУправление сессиями
/api/v1/sessions/:idGET, DELETEОперации с одной сессией
/api/v1/toolsGETСписок доступных инструментов
/api/v1/memoryGET, POSTОперации с памятью
/wsWSWebSocket-эндпоинт для связи в реальном времени
/webhooks/:channelPOSTПриёмник входящих вебхуков для каналов

Подробная документация по API — в разделах HTTP API шлюза и WebSocket шлюза.

Примеры

bash
# Запуск на порту по умолчанию
prx gateway

# Привязка ко всем интерфейсам на порту 8080
prx gateway --host 0.0.0.0 --port 8080

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

# Ограничение CORS
prx gateway --cors-origin "https://app.example.com,https://admin.example.com"

# Отладочное логирование
prx gateway --log-level debug

За обратным прокси

В промышленной эксплуатации размещайте шлюз за обратным прокси (Nginx, Caddy и т.д.) для терминации TLS и балансировки нагрузки:

# Пример Caddy
api.example.com {
    reverse_proxy localhost:3120
}
nginx
# Пример 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;
    }
}

Сигналы

СигналПоведение
SIGHUPПерезагрузка конфигурации
SIGTERMКорректное завершение (дожидается завершения текущих запросов)

См. также

Released under the Apache-2.0 License.