Конфигурационный файл rudesktop-relay.toml#

Файл rudesktop-relay.toml — дополнительная конфигурация relay, компонента сервера, через который устройства обмениваются трафиком при подключении не напрямую. Используется при развёртывании мостов и для параметров, которые нельзя задать в /etc/default/rudesktop

Описание#

Файл по пути /etc/rudesktop-relay.toml установщиком не создаётся. Чтобы relay читал его, добавьте в /etc/default/rudesktop строку:

RELAY_ARGS='-C /etc/rudesktop-relay.toml'

Без файла relay работает на значениях из /etc/default/rudesktop: адрес сервера берётся из PUBLIC_HOST:PUBLIC_PORT, подключение к базе данных — из POSTGRES_*, Redis — из REDIS_URL

Приоритет параметров (от меньшего к большему):

  1. значения из /etc/default/rudesktop

  2. ключи rudesktop-relay.toml

  3. аргументы из RELAY_ARGS (перекрывают одноимённые ключи файла)

Режим моста#

relay работает как мост, если в файле задан раздел [master] с адресом главного сервера. С таким разделом relay подключается к главному серверу по WebSocket и использует его базу данных вместо локальной, а ключ api_key на мосте и на главном сервере должен совпадать — по нему серверы аутентифицируют друг друга

Подсказка

Полный порядок развёртывания моста с примером файла — на странице Настройка мостов

Ключи#

Мост#

Ключ

Назначение

api_key

Общий секрет моста и главного сервера; значения на обеих сторонах должны совпадать

master.url

Адрес главного сервера для режима моста, например wss://192.168.10.10/v1/. Заданный ключ переводит relay в режим моста

Подключение к базе данных и Redis#

Ключ

Назначение

db_host / db_port / db_name / db_user / db_pass

Подключение к PostgreSQL. По умолчанию — значения POSTGRES_* из /etc/default/rudesktop

db_pool_size

Размер пула соединений с базой данных. По умолчанию 64

db_ca_cert

Путь к сертификату CA для SSL-соединения с БД

redis_server

Адрес Redis в формате URL. По умолчанию — значение REDIS_URL из /etc/default/rudesktop

Важно

Режим SSL к базе данных ключом db_ssl_mode задать нельзя: независимо от файла всегда используется переменная POSTGRES_SSL_MODE из /etc/default/rudesktop

Слушатели и сертификаты#

Ключ

Назначение

[[server]]

Массив слушателей relay. В каждом элементе: listen — адрес (host:port) или путь unix-сокета (начинается с /), key и cert — пути к ключу и сертификату TLS (без них слушатель работает без шифрования), webroot — каталог, из которого HTTP-слушатель отдаёт файлы проверки домена при автоматическом выпуске сертификатов. Если слушатели не заданы, relay слушает unix-сокет /run/rudesktop/rude.sock

ca_key / ca_cert

Пути к ключу и сертификату корневого центра сертификации, которым сервер подписывает сертификаты устройств и мостов. По умолчанию /var/lib/rudesktop/ca/CA.key и /var/lib/rudesktop/ca/CA.pem

Поведение соединений#

Примечание

Способ подключения (auto / прямое / через ретранслятор), выдача нового ID при смене hostname и использование hostname как ID настраиваются в веб-интерфейсе на странице Настройки — в файле они не задаются

Ключ

Назначение

use_public_ip

Возвращать клиенту адрес ретранслятора по тому узлу, к которому клиент подключился. Для сервера с несколькими сетевыми интерфейсами; аналог аргумента -p

trace

Включает запись в лог обмена сообщениями протокола между клиентами и сервером; уровень детализации 1–9. Аналог аргумента -t

Статусы устройств и кеш#

Ключ

Назначение

cache_ttl

Время жизни в Redis кеша состояния подключенных устройств (адрес, версия, статус), секунды. По умолчанию 300

flush_interval

Как часто изменения статусов устройств переносятся из очереди Redis в базу данных, секунды. По умолчанию 60

flush_batch

Сколько изменений статусов записывается в базу за один раз. По умолчанию 1000

cache_preload

Загрузить состояние всех устройств из базы данных в кеш Redis при старте relay, до первых подключений. По умолчанию выключено — кеш заполняется по мере обращений

keep_statuses

Не сбрасывать статусы устройств при перезапуске relay. По умолчанию выключено — при каждом старте службы все устройства отмечаются офлайн до следующего выхода на связь

disable_updater

Отключить фоновый перенос изменений статусов устройств из Redis в базу данных (задачу, управляемую flush_interval и flush_batch). Статусы в базе перестают обновляться. По умолчанию выключено — перенос выполняется

Логи и диагностика#

Ключ

Назначение

log_level

Уровень логирования: trace, debug, info, warn, error. По умолчанию info

log_path

Путь к файлу лога relay. По умолчанию /var/log/rudesktop/server.log

Примеры#

Диагностика соединений#

Если подключения к серверу устанавливаются с ошибками, на время диагностики включите подробный лог и трассировку протокола:

log_level = "debug"
trace = 5

После диагностики верните log_level = "info" и удалите trace: с трассировкой файл лога быстро растёт

Не сбрасывать статусы при перезапусках#

Если relay перезапускается несколько раз подряд (например, во время работ на сервере), чтобы устройства не отмечались офлайн при каждом старте, добавьте:

keep_statuses = true

Уберите ключ по окончании работ: при штатной работе статусы должны сбрасываться при старте, иначе устройства, отключившиеся во время простоя сервера, будут оставаться числиться онлайн

Применение изменений#

После изменения файла перезапустите relay:

rude restart rudesktop-relay.service