(docs) Reorganize docs/examples section for clarity

docs/examples/server/server.jitsi.datachannel.yaml

@@ -0,0 +1,37 @@
+# Серверный конфиг: jitsi + datachannel
+# Запуск: olcrtc docs/examples/server.jitsi.datachannel.yaml
+
+mode: srv
+
+auth:
+  provider: jitsi
+
+# Для jitsi: полный URL комнаты (https://host/room или host/room).
+# Должен совпадать с клиентом.
+# Доступные серверы: meet1.arbitr.ru или meet.cryptopro.ru
+# Проверьте в браузере, какой работает в вашей сети.
+room:
+  id: "https://meet1.arbitr.ru/REPLACE_WITH_ROOM_NAME"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: datachannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+data: data
+debug: false

docs/examples/server/server.jitsi.seichannel.yaml

@@ -0,0 +1,43 @@
+# Серверный конфиг: jitsi + seichannel
+# Запуск: olcrtc docs/examples/server.jitsi.seichannel.yaml
+
+mode: srv
+
+auth:
+  provider: jitsi
+
+# Для jitsi: полный URL комнаты (https://host/room или host/room).
+# Должен совпадать с клиентом.
+# Доступные серверы: meet1.arbitr.ru или meet.cryptopro.ru
+# Проверьте в браузере, какой работает в вашей сети.
+room:
+  id: "https://meet1.arbitr.ru/REPLACE_WITH_ROOM_NAME"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: seichannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+sei:
+  fps: 60
+  batch_size: 64
+  fragment_size: 900
+  ack_timeout_ms: 2000
+
+data: data
+debug: false

docs/examples/server/server.jitsi.videochannel.yaml

@@ -0,0 +1,50 @@
+# Серверный конфиг: jitsi + videochannel
+# Запуск: olcrtc docs/examples/server.jitsi.videochannel.yaml
+
+mode: srv
+
+auth:
+  provider: jitsi
+
+# Для jitsi: полный URL комнаты (https://host/room или host/room).
+# Должен совпадать с клиентом.
+# Доступные серверы: meet1.arbitr.ru или meet.cryptopro.ru
+# Проверьте в браузере, какой работает в вашей сети.
+room:
+  id: "https://meet1.arbitr.ru/REPLACE_WITH_ROOM_NAME"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: videochannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+video:
+  width: 1920
+  height: 1080
+  fps: 30
+  bitrate: "2M"
+  hw: none
+  codec: qrcode
+  qr_size: 0
+  qr_recovery: low
+  tile_module: 4
+  tile_rs: 20
+
+ffmpeg: ffmpeg
+data: data
+debug: false

docs/examples/server/server.jitsi.vp8channel.yaml

@@ -0,0 +1,41 @@
+# Серверный конфиг: jitsi + vp8channel
+# Запуск: olcrtc docs/examples/server.jitsi.vp8channel.yaml
+
+mode: srv
+
+auth:
+  provider: jitsi
+
+# Для jitsi: полный URL комнаты (https://host/room или host/room).
+# Должен совпадать с клиентом.
+# Доступные серверы: meet1.arbitr.ru или meet.cryptopro.ru
+# Проверьте в браузере, какой работает в вашей сети.
+room:
+  id: "https://meet1.arbitr.ru/REPLACE_WITH_ROOM_NAME"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: vp8channel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+vp8:
+  fps: 60
+  batch_size: 64
+
+data: data
+debug: false

docs/examples/server/server.telemost.datachannel.yaml

@@ -0,0 +1,35 @@
+# Серверный конфиг: telemost + datachannel
+# Запуск: olcrtc docs/examples/server.telemost.datachannel.yaml
+
+mode: srv
+
+auth:
+  provider: telemost
+
+# Для telemost: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_TELEMOST_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: datachannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+data: data
+debug: false

docs/examples/server/server.telemost.seichannel.yaml

@@ -0,0 +1,41 @@
+# Серверный конфиг: telemost + seichannel
+# Запуск: olcrtc docs/examples/server.telemost.seichannel.yaml
+
+mode: srv
+
+auth:
+  provider: telemost
+
+# Для telemost: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_TELEMOST_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: seichannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+sei:
+  fps: 60
+  batch_size: 64
+  fragment_size: 900
+  ack_timeout_ms: 2000
+
+data: data
+debug: false

docs/examples/server/server.telemost.videochannel.yaml

@@ -0,0 +1,48 @@
+# Серверный конфиг: telemost + videochannel
+# Запуск: olcrtc docs/examples/server.telemost.videochannel.yaml
+
+mode: srv
+
+auth:
+  provider: telemost
+
+# Для telemost: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_TELEMOST_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: videochannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+video:
+  width: 1920
+  height: 1080
+  fps: 30
+  bitrate: "2M"
+  hw: none
+  codec: qrcode
+  qr_size: 0
+  qr_recovery: low
+  tile_module: 4
+  tile_rs: 20
+
+ffmpeg: ffmpeg
+data: data
+debug: false

docs/examples/server/server.telemost.vp8channel.yaml

@@ -0,0 +1,39 @@
+# Серверный конфиг: telemost + vp8channel
+# Запуск: olcrtc docs/examples/server.telemost.vp8channel.yaml
+
+mode: srv
+
+auth:
+  provider: telemost
+
+# Для telemost: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_TELEMOST_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: vp8channel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+vp8:
+  fps: 60
+  batch_size: 64
+
+data: data
+debug: false

docs/examples/server/server.wbstream.datachannel.yaml

@@ -0,0 +1,35 @@
+# Серверный конфиг: wbstream + datachannel
+# Запуск: olcrtc docs/examples/server.wbstream.datachannel.yaml
+
+mode: srv
+
+auth:
+  provider: wbstream
+
+# Для wbstream: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_WB_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: datachannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+data: data
+debug: false

docs/examples/server/server.wbstream.seichannel.yaml

@@ -0,0 +1,41 @@
+# Серверный конфиг: wbstream + seichannel
+# Запуск: olcrtc docs/examples/server.wbstream.seichannel.yaml
+
+mode: srv
+
+auth:
+  provider: wbstream
+
+# Для wbstream: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_WB_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: seichannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+sei:
+  fps: 60
+  batch_size: 64
+  fragment_size: 900
+  ack_timeout_ms: 2000
+
+data: data
+debug: false

docs/examples/server/server.wbstream.videochannel.yaml

@@ -0,0 +1,48 @@
+# Серверный конфиг: wbstream + videochannel
+# Запуск: olcrtc docs/examples/server.wbstream.videochannel.yaml
+
+mode: srv
+
+auth:
+  provider: wbstream
+
+# Для wbstream: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_WB_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: videochannel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+video:
+  width: 1920
+  height: 1080
+  fps: 30
+  bitrate: "2M"
+  hw: none
+  codec: qrcode
+  qr_size: 0
+  qr_recovery: low
+  tile_module: 4
+  tile_rs: 20
+
+ffmpeg: ffmpeg
+data: data
+debug: false

docs/examples/server/server.wbstream.vp8channel.yaml

@@ -0,0 +1,39 @@
+# Серверный конфиг: wbstream + vp8channel
+# Запуск: olcrtc docs/examples/server.wbstream.vp8channel.yaml
+
+mode: srv
+
+auth:
+  provider: wbstream
+
+# Для wbstream: Room ID, который вернул сервис.
+# Должен совпадать с клиентом.
+room:
+  id: "REPLACE_WITH_WB_ROOM_ID"
+
+crypto:
+  # 32 байта в hex (64 символа). Сгенерировать: openssl rand -hex 32
+  # Можно использовать key_file: "./olcrtc.key", чтобы не хранить секрет прямо здесь.
+  key: "REPLACE_ME_WITH_64_HEX_CHARS" # должен совпадать с клиентом
+
+net:
+  transport: vp8channel
+  dns: "8.8.8.8:53"
+
+liveness:
+  interval: 10s
+  timeout: 5s
+  failures: 3
+
+socks:
+  proxy_addr: "" # например "127.0.0.1"
+  proxy_port: 0 # например 1080
+  proxy_user: "" # необязательная auth для upstream-прокси (RFC 1929)
+  proxy_pass: ""
+
+vp8:
+  fps: 60
+  batch_size: 64
+
+data: data
+debug: false