doc: sync doc with client-id key

This commit is contained in:
zarazaex69
2026-05-06 18:31:55 +03:00
parent 8be56493f0
commit df7934463b
4 changed files with 50 additions and 12 deletions

View File

@@ -96,6 +96,14 @@ Enter Room ID:
Для **jazz** и **wbstream** можно нажать Enter - ID сгенерируется автоматически,
скрипт сам его вытащит из логов и покажет.
### Client ID
```
Enter Client ID [default: default]:
```
Это обязательный идентификатор клиента. Он должен быть одинаковым на сервере и клиенте.
### DNS
```
@@ -132,10 +140,11 @@ Container name: olcrtc-server
Carrier: telemost
Transport: vp8channel
Room ID: 75587919855134
Client ID: default
Encryption key: 4fc9ab159c0268a12766be00c0a85138df5905f72c5eb5780c380507ebe0174d
```
**Сохрани Room ID и Encryption key** - они нужны для клиента.
**Сохрани Room ID, Client ID и Encryption key** - они нужны для клиента.
---
@@ -149,7 +158,15 @@ cd olcrtc
./script/cnc.sh
```
Отвечай на те же вопросы что на сервере - **carrier, transport, room ID должны совпадать**.
Отвечай на те же вопросы что на сервере - **carrier, transport, room ID и client ID должны совпадать**.
Когда спросит client ID:
```
Enter Client ID [default: default]: default
```
Введи тот же `client ID`, который использовал на сервере.
Когда спросит ключ:
@@ -174,6 +191,7 @@ SOCKS5 port [default: 8808]:
[+] Client started successfully!
Container name: olcrtc-client
Client ID: default
SOCKS5 proxy: 127.0.0.1:8808
```

View File

@@ -136,7 +136,19 @@ openssl rand -hex 32
---
## Шаг 7: Запустить сервер
## Шаг 7: Придумать client ID
Это обязательный идентификатор клиента. Он должен совпадать на сервере и клиенте, иначе сервер отклонит соединение.
```sh
CLIENT_ID=my-phone
```
Подойдёт любая короткая строка без пробелов: `home-laptop`, `android-01`, `pc`.
---
## Шаг 8: Запустить сервер
На серверной машине (VPS и т.д.). Подбери нужную комбинацию carrier + transport из матрицы в [settings.md](settings.md).
@@ -148,6 +160,7 @@ openssl rand -hex 32
-carrier telemost \
-transport vp8channel \
-id 75587912855134 \
-client-id "$CLIENT_ID" \
-key d823fa01cb3e0609b67322f7cf984c4ee2e4ce2e294936fc24ef38c9e59f4799 \
-link direct \
-dns 1.1.1.1:53 \
@@ -166,6 +179,7 @@ openssl rand -hex 32
-carrier jazz \
-transport datachannel \
-id any \
-client-id "$CLIENT_ID" \
-key d823fa01cb3e0609b67322f7cf984c4ee2e4ce2e294936fc24ef38c9e59f4799 \
-link direct \
-dns 1.1.1.1:53 \
@@ -188,6 +202,7 @@ Jazz room created: abc123xyz
-carrier wbstream \
-transport seichannel \
-id any \
-client-id "$CLIENT_ID" \
-key <hex-key> \
-link direct \
-dns 1.1.1.1:53 \
@@ -208,9 +223,9 @@ Jazz room created: abc123xyz
---
## Шаг 8: Запустить клиент
## Шаг 9: Запустить клиент
На своей машине. Carrier, transport, id и key должны **точно совпадать** с сервером.
На своей машине. Carrier, transport, id, `client-id` и key должны **точно совпадать** с сервером.
### telemost + vp8channel
@@ -220,6 +235,7 @@ Jazz room created: abc123xyz
-carrier telemost \
-transport vp8channel \
-id 75587929855134 \
-client-id "$CLIENT_ID" \
-key d823fa01cb3e0609b67322f7cf984c4ee2e4ce2e294936fc24ef38c9e59f4799 \
-link direct \
-dns 1.1.1.1:53 \
@@ -238,6 +254,7 @@ Jazz room created: abc123xyz
-carrier jazz \
-transport datachannel \
-id abc123xyz \
-client-id "$CLIENT_ID" \
-key <hex-key> \
-link direct \
-dns 1.1.1.1:53 \
@@ -254,7 +271,7 @@ SOCKS5 server listening on 127.0.0.1:1080
---
## Шаг 9: Проверить
## Шаг 10: Проверить
```sh
curl --socks5-hostname 127.0.0.1:1080 https://icanhazip.com

View File

@@ -23,6 +23,7 @@
| `-carrier` | `telemost`, `jazz` или `wbstream` |
| `-transport` | `datachannel`, `vp8channel`, `seichannel` или `videochannel` |
| `-id` | Room ID. Для jazz/wbstream можно `any` - сгенерируется автоматически |
| `-client-id` | Общий идентификатор клиента. Должен совпадать на сервере и клиенте |
| `-key` | Ключ шифрования hex 64 символа. Генерация: `openssl rand -hex 32` |
| `-link` | Всегда `direct` |
| `-data` | Всегда `data` |
@@ -101,12 +102,12 @@
```sh
# сервер
./olcrtc -mode srv -carrier telemost -transport vp8channel \
-id <room-id> -key <hex-key> -link direct -data data \
-id <room-id> -client-id <client-id> -key <hex-key> -link direct -data data \
-vp8-fps 60 -vp8-batch 64
# клиент
./olcrtc -mode cnc -carrier telemost -transport vp8channel \
-id <room-id> -key <hex-key> -link direct -data data \
-id <room-id> -client-id <client-id> -key <hex-key> -link direct -data data \
-socks-host 127.0.0.1 -socks-port 1080 \
-vp8-fps 60 -vp8-batch 64
```
@@ -116,11 +117,11 @@
```sh
# сервер - room ID создастся сам, смотри логи
./olcrtc -mode srv -carrier jazz -transport datachannel \
-id any -key <hex-key> -link direct -data data
-id any -client-id <client-id> -key <hex-key> -link direct -data data
# клиент
./olcrtc -mode cnc -carrier jazz -transport datachannel \
-id <room-id> -key <hex-key> -link direct -data data \
-id <room-id> -client-id <client-id> -key <hex-key> -link direct -data data \
-socks-host 127.0.0.1 -socks-port 1080
```
@@ -129,13 +130,13 @@
```sh
# сервер
./olcrtc -mode srv -carrier telemost -transport videochannel \
-id <room-id> -key <hex-key> -link direct -data data \
-id <room-id> -client-id <client-id> -key <hex-key> -link direct -data data \
-video-codec qrcode -video-w 1080 -video-h 1080 \
-video-fps 60 -video-bitrate 5000k -video-hw none
# клиент
./olcrtc -mode cnc -carrier telemost -transport videochannel \
-id <room-id> -key <hex-key> -link direct -data data \
-id <room-id> -client-id <client-id> -key <hex-key> -link direct -data data \
-socks-host 127.0.0.1 -socks-port 1080 \
-video-codec qrcode -video-w 1080 -video-h 1080 \
-video-fps 60 -video-bitrate 5000k -video-hw none

View File

@@ -31,6 +31,8 @@ Or wait for the release or at least a release
[Setting matrix](docs/settings.md)
Во всех актуальных примерах запуска нужен `-client-id <id>`: значение должно совпадать на сервере и клиенте.
## Build