Files
free-turn-proxy/docs/sub.md
T
2026-06-17 10:03:40 +03:00

48 lines
2.2 KiB
Markdown

# Формат подписок `sub.md`
Для удобного распространения списка серверов `Free Turn Proxy` поддерживает систему подписок.
Файл `sub.md` - это обычный текстовый файл, который хостится на любом HTTP-сервере.
## Использование в клиенте
```bash
./client -sub https://example.com/sub.md -link "https://vk.ru/call/join/..."
```
Клиент скачает подписку, найдет первый доступный сервер и автоматически применит его конфигурацию. Уникальная ссылка `-link` по-прежнему требуется.
> [!NOTE]
> **Про авторизацию:** клиент всегда шлёт Client ID, сервер всегда его читает. Чтобы ограничить доступ, запустите сервер с `-clients-file` и добавьте нужные ID в `clients.json`; без этого флага ID просто игнорируется.
## Формат файла
Файл состоит из глобальных параметров (начинаются с `#`), локальных параметров сервера (начинаются с `##`) и самих [freeturn://](uri.md) ссылок.
Пример:
```text
#name: Free Turn Proxy Servers
#refresh: 1h
#color: #4A90E2
freeturn://eyJ2IjoxLCJwcm92aWRlciI6InZrIiwicGVlciI6IjEuMi4zLjQ6NTYwMDAifQ
##name: RU-1
##ip: 1.2.3.4
##comment: Основной сервер в Москве
freeturn://eyJ2IjoxLCJwcm92aWRlciI6InZrIiwicGVlciI6IjUuNi43Ljg6NTYwMDAifQ
##name: EU-Backup
##comment: Резервный сервер
```
`freeturn://` теперь несёт base64url(json) со всеми параметрами подключения - формат
описан в [docs/uri.md](uri.md).
| Поле | Описание |
|------|----------|
| `#name` | Имя подписки. |
| `#refresh` | Рекомендуемый интервал обновления. |
| `##name` | Имя конкретного узла. |
| `##ip` | IP-адрес узла. |
| `##comment` | Комментарий для сервера. |