Перейти к основному содержимому
Версия: 2.12

websocket

Псевдонимы: ws
Перезагрузка без перезапуска
Перезагружаются только сертификаты TLS и только для соединений, принятых после этого. Любая другая настройка websocket, включая verify_and_map и pinned_certs, приводит к ошибке перезагрузки.

Конфигурация включения интерфейса WebSocket.

Свойства​

ИмяОписаниеТипПо умолчаниюПерезагрузка
hoststring0.0.0.0Нет
portПорт приёма клиентских соединений WebSocket. Значения по умолчанию нет: слушатель запускается только после задания порта здесь или через listen. TLS обязателен, если no_tls не равен true.integer-Нет
listenstring-Нет
advertiseОбъявляемый клиентский адрес <host>:<port>. Полезен для кластеров за NAT.string-Нет
tlsobject-Да*
no_tlsboolean-Нет
same_originПараметр относится к клиентам в веб-браузере, например [nats.js][nats.js]. При значении true HTTP-заголовок Origin должен соответствовать имени хоста запроса. Подробнее см. документацию о [совместном использовании ресурсов между источниками][cors]. Проверка выполняется только при наличии заголовка Origin, который браузеры отправляют, а небраузерные клиенты обычно нет. [nats.js]: https://github.com/nats-io/nats.js [cors]: https://developer.mozilla.org/en-US/docs/Web/HTTP/CORSbooleanfalseНет
allowed_originsСписок допустимых источников. Если список пуст и same_origin равен false, разрешены клиенты из любого источника. Список задаёт единственные допустимые значения заголовка Origin в запросе клиента. Схема, хост и порт должны совпадать. Если TCP-порт в URL не указан, для схемы "http://" подразумевается порт 80, а для "https://" — 443.string-Нет
handshake_timeoutОбщее время, отведённое серверу на чтение клиентского запроса и отправку ответа клиенту, включая рукопожатие TLS.duration-Нет
compressВключает поддержку сжатых кадров WebSocket на сервере. Для использования сжатия его должны поддерживать и сервер, и клиент.boolean-Нет
authorizationobject-Нет
headersДополнительные HTTP-заголовки в ответе на переход к WebSocket.string-Нет
ping_intervalИнтервал отправки ping WebSocket сервером. Значение 0 отключает отправку.duration2mНет
user_cookieИмя HTTP-cookie с именем пользователя для клиентов, аутентифицирующихся через сеанс браузера.string-Нет
pass_cookieИмя HTTP-cookie с паролем.string-Нет
token_cookieИмя HTTP-cookie с токеном аутентификации.string-Нет
jwt_cookieИмя HTTP-cookie, которое при наличии используется как JWT клиента. HTTP-сервер должен устанавливать cookie, как описано [здесь][cookie]. Это полезно при создании клиентских JWT NATS типа Bearer в результате аутентификации. После успешной аутентификации HTTP-сервер может выдать JWT пользователя, безопасно сохранив его без доступа посторонних скриптов. Это должны быть [JWT NATS][jwt]. Примечание: если клиент передаёт JWT в протоколе CONNECT, этот параметр игнорируется. [cookie]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#restrict_access_to_cookies [jwt]: https://docs.nats.io/nats-server/configuration/securing_nats/jwtstring-Нет
no_auth_userЕсли клиент WebSocket не передаёт имя пользователя при подключении, это имя используется по умолчанию на этапе аутентификации. Для клиентов WebSocket оно переопределяет любое значение no_auth_user из основного файла конфигурации. Листовой узел, подключающийся по WebSocket, также использует его вместо параметра no_auth_user верхнего уровня. Примечание: этот вариант несовместим с запуском сервера в режиме оператора.string-Нет

* Ограничения перезагрузки описаны на странице параметра.