Files
free-turn-proxy/docs/quickstart.md
T
samosvalishe 8d551c61ae feat(installer): глобальный CLI freeturn, авторизация по Client ID по умолчанию и компактный QR
- Включение авторизации по Client ID (allowlist) по умолчанию в мастере установки
- Создание глобального симлинка /usr/local/bin/freeturn для вызова из любой директории
- Умный поиск имени клиента с поддержкой дефисов/регистра (client1 -> client-1)
- Очистка от комментариев и Low ECC (-l L) для компактного QR-кода (~51 колонка) в PowerShell/терминалах
- Интерактивный запрос на вывод QR-кода первого клиента сразу после завершения установки
- Обновление подсказок и документации на команду freeturn
2026-09-07 18:15:56 +03:00

4.5 KiB
Raw Blame History

Быстрый Старт

Требования

  • VPS с публичным IP (скрипт установки сам развернет Docker и VPN-бэкенд AmneziaWG 3.1 / WireGuard).
  • Активная ссылка VK Calls: https://vk.ru/call/join/... (создайте сами, звонок не завершайте).

Шаг 1: Запуск Сервера (VPS)

Интерактивный скрипт поднимет Docker Compose со службами free-turn-proxy и freeturn-awg (AmneziaWG 3.1), сгенерирует ключи обфускации, создаст первого клиента и выведет QR-код прямо в терминале:

curl -fsSL https://raw.githubusercontent.com/samosvalishe/free-turn-proxy/master/scripts/install.sh | sudo bash

Tip

Прямое подключение (Direct AWG): Отсканируйте выведенный терминальный QR-код в официальном приложении AmneziaWG/AmneziaVPN на телефоне (или импортируйте .conf на ПК) - туннель готов к работе сразу!

Добавление новых клиентов: Выполните на сервере:

freeturn client add myphone

Шаг 2: Запуск Клиента Free Turn Proxy (ПК)

Если прямой UDP до вашего VPS блокируется провайдером, запустите клиент free-turn-proxy. Он перенаправит трафик через TURN-релей провайдера под видом аудиозвонка. Клиент автоматически создаёт маршруты-исключения для IP TURN-серверов (-routes).

Linux:

curl -L -o client https://github.com/samosvalishe/free-turn-proxy/releases/latest/download/client-linux-amd64
chmod +x client
sudo ./client -listen 127.0.0.1:9000 -peer <vps_ip>:56000 -link "<vk-link>" -obf-profile rtpopus3 -obf-key <ВАШ_КЛЮЧ> -client-id <ВАШ_CLIENT_ID> -routes

Windows (PowerShell от администратора):

Invoke-WebRequest -Uri https://github.com/samosvalishe/free-turn-proxy/releases/latest/download/client-windows-amd64.exe -OutFile client.exe
.\client.exe -peer <vps_ip>:56000 -provider vk -link "<vk-link>" -listen 127.0.0.1:9000 -n 12 -streams-per-cred 12 -obf-profile rtpopus3 -obf-key <ВАШ_КЛЮЧ> -dns-servers 192.168.31.1 -dns-mode doh -client-id <ВАШ_CLIENT_ID> -routes

macOS:

# Apple Silicon (M1/M2/M3): client-darwin-arm64 | Intel: client-darwin-amd64
sudo ./client -listen 127.0.0.1:9000 -peer <vps_ip>:56000 -link "<vk-link>" -obf-profile rtpopus3 -obf-key <ВАШ_КЛЮЧ> -client-id <ВАШ_CLIENT_ID> -routes

Важно: В настройках вашего VPN-клиента (AmneziaWG или WireGuard) при работе через прокси используйте релейный конфиг (client-1-relay.conf, где Endpoint = 127.0.0.1:9000 и MTU = 1280). Включайте VPN только после того, как клиент выведет Ensuring route to ....

Tip

Упрощение: Вместо длинных флагов можно передать ссылку freeturn:// (генерируется установщиком) или подписку (-sub):

sudo ./client "freeturn://eyJ2Ijox..." -link "<vk-link>" -routes

Подробнее в uri.md и sub.md.


Шаг 3: Мобильные Устройства (Termux)

На мобильных сетях маршруты не нужны, но есть своя специфика (блокировка DNS, добавление в исключения VPN).

termux-wake-lock
# Скачивание: curl -L -o client https://github.com/samosvalishe/free-turn-proxy/releases/latest/download/client-android-arm64 && chmod +x client

# Обязательно укажите ваш ключ и DNS оператора (можно узнать в настройках APN)
./client -listen 127.0.0.1:9000 -peer <vps_ip>:56000 -link "<vk-link>" -obf-profile rtpopus3 -obf-key <ВАШ_КЛЮЧ> -dns-servers <ip_dns_оператора> -client-id <ВАШ_CLIENT_ID>

Обязательно добавьте приложение Termux в исключения вашего VPN-клиента. Подробнее в mobile.md.