Skip to content

Dushnyj/TG-Proxy-Relay

Repository files navigation

TG Proxy VPS Relay

TG Proxy VPS Relay - серверная часть для TG Proxy Android. Relay принимает авторизованный WebSocket-трафик от Android-приложения и открывает TCP-соединения к Telegram DC.

TG Proxy VPS Relay overview

Навигация

Как это работает

Telegram Android
  -> MTProto Proxy (127.0.0.1:1443)
  -> TG Proxy Android route engine
  -> WebSocket/TLS
  -> tgproxy-relay
  -> TCP Telegram DC:443

Публичный HTTPS-домен обычно проксирует один путь:

WS   /apiws?dc=2&media=0
GET  /apiws/healthz      -> /healthz
GET  /apiws/version      -> /version
POST /apiws/test-routes  -> /test-routes

Все endpoints требуют заголовок:

Authorization: Bearer <token>

Релизные файлы

GitHub Actions публикует:

TG-Proxy-Relay-v<version>-linux-amd64.tar.gz
TG-Proxy-Relay-v<version>-linux-arm64.tar.gz
SHA256SUMS.txt

Для большинства обычных VPS нужен linux-amd64. Для ARM VPS нужен linux-arm64.

Установка

Ручная установка описана в docs/INSTALL.md. Если используется TG Proxy Android, удобнее открыть Настройки -> VPS Relay -> Автонастройка VPS.

Reverse proxy

Relay обычно слушает 127.0.0.1:18080, а наружу публикуется через nginx, Caddy или Apache на HTTPS-домене. Безопасные path-based примеры есть в docs/REVERSE_PROXY.md.

Токены

На сервере хранятся хэши токенов, а не raw-токены:

tgproxy-relay -token "long-random-token" -print-token-hash

Полученный hash записывается в config.json. Подробнее: docs/TOKENS.md.

Автонастройка из Android

TG Proxy Android умеет:

  • проверить VPS без изменений;
  • найти уже установленный совместимый Relay;
  • добавить новый token в существующий Relay;
  • установить или обновить Relay, если пользователь владеет VPS;
  • импортировать подключение без SSH-данных.

Подробнее: docs/ANDROID_AUTO_SETUP.md.

Документация

Сборка

go test ./...
go build -trimpath -o tgproxy-relay ./cmd/tgproxy-relay

Release workflow задаёт internal/relay.Version из Git-тега.

Безопасность

Не публикуйте raw-токены, SSH-данные, приватные ключи и полные production-конфиги. Правила сообщения об уязвимостях описаны в SECURITY.md.

Лицензия

MIT, см. LICENSE.

About

VPS Relay сервер для TG Proxy Android: WebSocket/TLS маршрут к Telegram DC с автонастройкой, токенами и release assets.

Topics

Resources

License

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages