GitHub/olcrtc
1
0
Fork 0
mirror of https://github.com/openlibrecommunity/olcrtc.git synced 2026-05-26 07:08:11 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
12a28e6cbf2fcce04c15a813438454456e1aae8b
olcrtc/docs/configuration.md

11 KiB
Raw Blame History

License Golang

Настройка YAML

olcrtc читает runtime-настройки из одного YAML-файла. CLI принимает ровно один аргумент - путь к конфигу; отдельных CLI-флагов для режима, транспорта и провайдера больше нет.

olcrtc /etc/olcrtc/server.yaml
olcrtc /etc/olcrtc/client.yaml

Готовые примеры:

Схема

YAML path Значение
mode srv, cnc или gen
auth.provider jitsi, telemost, wbstream, none
room.id ID/URL комнаты для выбранного auth-провайдера
room.channel необязательный ID канала для peer-routing сценариев
crypto.key / crypto.key_file общий ключ: 64 hex-символа, напрямую или из файла
net.transport datachannel, vp8channel, seichannel, videochannel
net.dns DNS resolver в формате host:port
socks.host / socks.port локальный SOCKS5 listener в mode: cnc
socks.user / socks.pass необязательная auth для входящих SOCKS5-подключений
socks.proxy_addr / socks.proxy_port исходящий SOCKS5-прокси на серверной стороне
socks.proxy_user / socks.proxy_pass необязательная auth для upstream-прокси (RFC 1929)
engine.name / engine.url / engine.token прямой engine-режим, только при auth.provider: none
video.* настройки videochannel
vp8.* настройки vp8channel
sei.* настройки seichannel
liveness.interval интервал ping по control stream, по умолчанию 10s
liveness.timeout таймаут pong, по умолчанию 5s
liveness.failures сколько pong можно пропустить до rebuild, по умолчанию 3
lifecycle.max_session_duration плановый rebuild сессии, например 6h; пусто = выключено
traffic.max_payload_size лимит зашифрованного wire-message; 0 = лимит транспорта
traffic.min_delay / traffic.max_delay необязательный pacing отправки, например 5ms / 30ms
gen.amount режим gen: сколько комнат создать
profiles[] список failover-профилей для srv/cnc
failover.retry_delay пауза перед следующим профилем, например 2s
failover.max_cycles сколько полных проходов по профилям сделать; 0 = бесконечно
data путь к директории с runtime-данными (names, surnames)
debug подробное логирование
ffmpeg путь к бинарнику ffmpeg для videochannel

crypto.key_file читается относительно YAML-файла. Нельзя одновременно задавать crypto.key и crypto.key_file.

mode: cnc запрещает слушать не-loopback адрес (0.0.0.0, LAN IP и т.п.), если не заданы оба поля socks.user и socks.pass.

Обязательный минимум

Сервер

mode: srv
auth:
  provider: jitsi
room:
  id: "https://meet1.arbitr.ru/REPLACE_ME_WITH_ROOM_ID"
crypto:
  key: "REPLACE_ME_WITH_64_HEX_CHARS"
net:
  transport: datachannel
  dns: "8.8.8.8:53"
data: data

Клиент

mode: cnc
auth:
  provider: jitsi
room:
  id: "https://meet1.arbitr.ru/REPLACE_ME_WITH_ROOM_ID"
crypto:
  key: "REPLACE_ME_WITH_64_HEX_CHARS"
net:
  transport: datachannel
  dns: "8.8.8.8:53"
socks:
  host: "127.0.0.1"
  port: 8808
data: data

Liveness

После CLIENT_HELLO / SERVER_WELCOME первый smux stream остаётся открытым как зашифрованный control stream. По нему olcrtc отправляет CONTROL_PING / CONTROL_PONG, чтобы проверять именно рабочий путь туннеля, а не только статус WebRTC-соединения.

liveness:
  interval: 10s
  timeout: 5s
  failures: 3

Когда порог пропущенных pong достигнут, текущая smux-сессия пересоздаётся. В failover-режиме профиль, который завершился после неудачного reconnect, отдаёт управление supervisor, и тот пробует следующий профиль.

Lifecycle Rotation

lifecycle.max_session_duration задаёт плановый верхний предел длительности одного звонка/сессии у провайдера. Когда время истекает, активная srv или cnc сессия закрывается и запускается заново с тем же конфигом.

lifecycle:
  max_session_duration: 6h

Поле необязательное. Формат - Go duration: 30m, 2h, 6h. Ноль и отрицательные значения не принимаются.

Traffic Shaping

traffic добавляет общий wrapper вокруг выбранного транспорта. Он может ограничить размер зашифрованного сообщения и добавить небольшую задержку перед отправкой. Данные не обрезаются: если payload не помещается в эффективный лимит, отправка завершается явной ошибкой.

traffic:
  max_payload_size: 4096
  min_delay: 5ms
  max_delay: 30ms

Лимит сжимается до MaxPayloadSize, который заявляет выбранный транспорт. Клиент и сервер также уменьшают smux frame size с учётом crypto overhead. Значение 0 не добавляет лимит сверх лимита транспорта. Если задан только min_delay, задержка фиксированная. Используй одинаковые traffic-настройки на обеих сторонах.

Failover Profiles

mode: srv и mode: cnc могут задавать profiles. Верхнеуровневые поля становятся общими defaults, а каждый профиль переопределяет только то, что указано внутри него.

mode: srv
crypto:
  key_file: ./olcrtc.key
net:
  dns: "8.8.8.8:53"
data: data

profiles:
  - name: wb-vp8
    auth:
      provider: wbstream
    room:
      id: "WB_ROOM_ID"
    net:
      transport: vp8channel

  - name: jitsi-dc
    auth:
      provider: jitsi
    room:
      id: "https://meet.example.org/olcrtc-room"
    net:
      transport: datachannel

failover:
  retry_delay: 2s
  max_cycles: 0

Порядок профилей и параметры комнаты должны быть совместимы на сервере и клиенте. Активные smux streams между профилями не мигрируют; новые подключения смогут восстановиться на следующем профиле.

mode: gen

gen оставлен для auth-провайдеров, которые реализуют создание комнат через API. Текущие встроенные провайдеры (jitsi, telemost, wbstream) не создают комнаты через olcrtc: для telemost и wbstream создай комнату на сайте сервиса и вставь её в room.id; для jitsi укажи URL комнаты.

Reference in New Issue View Git Blame Copy Permalink