GitHub/olcrtc
1
0
Fork 0
mirror of https://github.com/openlibrecommunity/olcrtc.git synced 2026-06-06 04:19:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

(docs) Reorganize docs/examples section for clarity

Browse Source
This commit is contained in:
Yuriy Samorodov
2026-05-25 19:14:07 +04:00
parent af9eeea740
commit fb5f62a313
26 changed files with 1 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/examples/client/client.jitsi.datachannel.yaml Normal file
View File

@@ -0,0 +1,36 @@
# Клиентский конфиг: jitsi + datachannel
# Запуск: olcrtc docs/examples/client.jitsi.datachannel.yaml
mode: cnc
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:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
data: data
debug: false

42
docs/examples/client/client.jitsi.seichannel.yaml Normal file
View File

@@ -0,0 +1,42 @@
# Клиентский конфиг: jitsi + seichannel
# Запуск: olcrtc docs/examples/client.jitsi.seichannel.yaml
mode: cnc
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:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
sei:
fps: 60
batch_size: 64
fragment_size: 900
ack_timeout_ms: 2000
data: data
debug: false

49
docs/examples/client/client.jitsi.videochannel.yaml Normal file
View File

@@ -0,0 +1,49 @@
# Клиентский конфиг: jitsi + videochannel
# Запуск: olcrtc docs/examples/client.jitsi.videochannel.yaml
mode: cnc
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:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
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

40
docs/examples/client/client.jitsi.vp8channel.yaml Normal file
View File

@@ -0,0 +1,40 @@
# Клиентский конфиг: jitsi + vp8channel
# Запуск: olcrtc docs/examples/client.jitsi.vp8channel.yaml
mode: cnc
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:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
vp8:
fps: 60
batch_size: 64
data: data
debug: false

34
docs/examples/client/client.telemost.datachannel.yaml Normal file
View File

@@ -0,0 +1,34 @@
# Клиентский конфиг: telemost + datachannel
# Запуск: olcrtc docs/examples/client.telemost.datachannel.yaml
mode: cnc
auth:
provider: telemost
# Для telemost: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_TELEMOST_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
data: data
debug: false

40
docs/examples/client/client.telemost.seichannel.yaml Normal file
View File

@@ -0,0 +1,40 @@
# Клиентский конфиг: telemost + seichannel
# Запуск: olcrtc docs/examples/client.telemost.seichannel.yaml
mode: cnc
auth:
provider: telemost
# Для telemost: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_TELEMOST_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
sei:
fps: 60
batch_size: 64
fragment_size: 900
ack_timeout_ms: 2000
data: data
debug: false

47
docs/examples/client/client.telemost.videochannel.yaml Normal file
View File

@@ -0,0 +1,47 @@
# Клиентский конфиг: telemost + videochannel
# Запуск: olcrtc docs/examples/client.telemost.videochannel.yaml
mode: cnc
auth:
provider: telemost
# Для telemost: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_TELEMOST_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
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

38
docs/examples/client/client.telemost.vp8channel.yaml Normal file
View File

@@ -0,0 +1,38 @@
# Клиентский конфиг: telemost + vp8channel
# Запуск: olcrtc docs/examples/client.telemost.vp8channel.yaml
mode: cnc
auth:
provider: telemost
# Для telemost: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_TELEMOST_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
vp8:
fps: 60
batch_size: 64
data: data
debug: false

34
docs/examples/client/client.wbstream.datachannel.yaml Normal file
View File

@@ -0,0 +1,34 @@
# Клиентский конфиг: wbstream + datachannel
# Запуск: olcrtc docs/examples/client.wbstream.datachannel.yaml
mode: cnc
auth:
provider: wbstream
# Для wbstream: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_WB_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
data: data
debug: false

40
docs/examples/client/client.wbstream.seichannel.yaml Normal file
View File

@@ -0,0 +1,40 @@
# Клиентский конфиг: wbstream + seichannel
# Запуск: olcrtc docs/examples/client.wbstream.seichannel.yaml
mode: cnc
auth:
provider: wbstream
# Для wbstream: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_WB_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
sei:
fps: 60
batch_size: 64
fragment_size: 900
ack_timeout_ms: 2000
data: data
debug: false

47
docs/examples/client/client.wbstream.videochannel.yaml Normal file
View File

@@ -0,0 +1,47 @@
# Клиентский конфиг: wbstream + videochannel
# Запуск: olcrtc docs/examples/client.wbstream.videochannel.yaml
mode: cnc
auth:
provider: wbstream
# Для wbstream: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_WB_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
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

38
docs/examples/client/client.wbstream.vp8channel.yaml Normal file
View File

@@ -0,0 +1,38 @@
# Клиентский конфиг: wbstream + vp8channel
# Запуск: olcrtc docs/examples/client.wbstream.vp8channel.yaml
mode: cnc
auth:
provider: wbstream
# Для wbstream: Room ID, который вернул сервис.
# Должен совпадать с сервером.
room:
id: "REPLACE_WITH_WB_ROOM_ID"
crypto:
# Можно использовать 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:
host: "127.0.0.1"
port: 8808
user: "" # необязательная входящая auth
pass: ""
vp8:
fps: 60
batch_size: 64
data: data
debug: false