mirror of
https://github.com/Flowseal/tg-ws-proxy.git
synced 2026-05-17 00:25:51 +03:00
Улучшена "архитектура" документации и настроен triage для issues (#801)
This commit is contained in:
deexsed
11
.github/CODEOWNERS
vendored
Normal file
11
.github/CODEOWNERS
vendored
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Default owners
|
||||||
|
* @Flowseal
|
||||||
|
|
||||||
|
# Automation and repository settings
|
||||||
|
.github/** @Flowseal
|
||||||
|
|
||||||
|
# Documentation
|
||||||
|
docs/** @Flowseal
|
||||||
|
|
||||||
|
# Core proxy implementation
|
||||||
|
proxy/** @Flowseal
|
||||||
19
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
19
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
@@ -4,17 +4,20 @@ description: Сообщить о проблеме
|
|||||||
labels: ['type: проблема', 'status: нуждается в сортировке']
|
labels: ['type: проблема', 'status: нуждается в сортировке']
|
||||||
|
|
||||||
body:
|
body:
|
||||||
- type: textarea
|
- type: input
|
||||||
id: description
|
id: app_version
|
||||||
attributes:
|
attributes:
|
||||||
label: Опишите вашу проблему
|
label: Версия TG WS Proxy
|
||||||
description: Чётко опишите проблему с которой вы столкнулись
|
description: Укажите версию приложения (например, v1.2.3)
|
||||||
placeholder: Описание проблемы
|
placeholder: vX.Y.Z
|
||||||
validations:
|
validations:
|
||||||
required: true
|
required: true
|
||||||
|
|
||||||
- type: textarea
|
- type: textarea
|
||||||
id: additions
|
id: description
|
||||||
attributes:
|
attributes:
|
||||||
label: Дополнительные детали
|
label: Опишите вашу проблему
|
||||||
description: Если у вас проблемы с работой прокси, то приложите файл логов в момент возникновения проблемы.
|
description: Чётко опишите проблему, с которой вы столкнулись
|
||||||
|
placeholder: Описание проблемы
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
6
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
blank_issues_enabled: false
|
||||||
|
|
||||||
|
contact_links:
|
||||||
|
- name: 📚 Документация
|
||||||
|
url: https://github.com/Flowseal/tg-ws-proxy/tree/main/docs
|
||||||
|
about: Ознакомьтесь с документацией перед созданием issue
|
||||||
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
37
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,37 @@
|
|||||||
|
name: 🚀 Предложение
|
||||||
|
title: '[Предложение] '
|
||||||
|
description: Предложить улучшение или новую функциональность
|
||||||
|
labels: ['type: предложение', 'status: нуждается в сортировке']
|
||||||
|
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: solution
|
||||||
|
attributes:
|
||||||
|
label: Предлагаемое решение
|
||||||
|
description: Опишите, как именно вы предлагаете улучшить проект
|
||||||
|
placeholder: |
|
||||||
|
Предлагаю добавить ...
|
||||||
|
Это позволит ...
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: dropdown
|
||||||
|
id: platform
|
||||||
|
attributes:
|
||||||
|
label: Для какой платформы актуально?
|
||||||
|
description: Выберите платформу, если предложение связано с конкретной ОС
|
||||||
|
options:
|
||||||
|
- Все платформы
|
||||||
|
- Windows
|
||||||
|
- macOS
|
||||||
|
- Linux
|
||||||
|
- Другое
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Дополнительный контекст
|
||||||
|
description: Добавьте примеры, ссылки, скриншоты или другие детали
|
||||||
|
placeholder: Любые дополнительные материалы по предложению
|
||||||
19
.github/labels.md
vendored
Normal file
19
.github/labels.md
vendored
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
# Labels Reference
|
||||||
|
|
||||||
|
Этот список фиксирует лейблы, которые используются в issue-шаблонах и workflow triage.
|
||||||
|
|
||||||
|
## Тип issue
|
||||||
|
|
||||||
|
- `type: проблема` — баг-репорты.
|
||||||
|
- `type: предложение` — предложения по улучшениям.
|
||||||
|
|
||||||
|
## Статус issue
|
||||||
|
|
||||||
|
- `status: нуждается в сортировке` — новый issue, ожидает первичного triage.
|
||||||
|
- `status: в работе` — issue взят в работу мейнтейнером.
|
||||||
|
|
||||||
|
## Важно
|
||||||
|
|
||||||
|
- Используйте лейблы строго в таком написании.
|
||||||
|
- Не создавайте дубликаты с похожими названиями.
|
||||||
|
- Если нужно изменить словарь лейблов, сначала обновите этот файл и связанные workflow.
|
||||||
34
.github/workflows/issue-triage.yml
vendored
Normal file
34
.github/workflows/issue-triage.yml
vendored
Normal file
@@ -0,0 +1,34 @@
|
|||||||
|
name: Auto comment on new issues
|
||||||
|
|
||||||
|
on:
|
||||||
|
issues:
|
||||||
|
types: [opened]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
issues: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
comment:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Comment on new issue
|
||||||
|
uses: peter-evans/create-or-update-comment@v5
|
||||||
|
with:
|
||||||
|
issue-number: ${{ github.event.issue.number }}
|
||||||
|
body: |
|
||||||
|
Спасибо за issue и за помощь проекту ❤️
|
||||||
|
|
||||||
|
Чтобы не терять ваше время, сначала проверьте две вещи:
|
||||||
|
- вы на последней версии: [Releases](https://github.com/${{ github.repository }}/releases)
|
||||||
|
- запускали по инструкции для своей ОС: [Быстрый старт](https://github.com/${{ github.repository }}/blob/main/docs/README.md#-быстрый-старт)
|
||||||
|
|
||||||
|
Если проблема осталась, пожалуйста, допишите в этот issue:
|
||||||
|
- версию `tg-ws-proxy`;
|
||||||
|
- вашу ОС и способ запуска (релизный бинарник / из исходников);
|
||||||
|
- короткое описание, как воспроизвести проблему (если возможно);
|
||||||
|
- лог/текст ошибки или скриншот.
|
||||||
|
|
||||||
|
Частый кейс: если не грузит медиа в Telegram, проверьте раздел в документации
|
||||||
|
«Не грузит фото/видео?» — [README](https://github.com/${{ github.repository }}/blob/main/docs/README.md#не-грузит-фотовидео).
|
||||||
|
|
||||||
|
После этого мы сможем быстрее воспроизвести проблему и дать точный ответ.
|
||||||
48
CONTRIBUTING.md
Normal file
48
CONTRIBUTING.md
Normal file
@@ -0,0 +1,48 @@
|
|||||||
|
# CONTRIBUTING
|
||||||
|
|
||||||
|
Спасибо за желание помочь проекту `tg-ws-proxy`.
|
||||||
|
|
||||||
|
## Перед созданием issue
|
||||||
|
|
||||||
|
1. Проверьте документацию в `docs/README.md`.
|
||||||
|
2. Убедитесь, что похожий issue еще не открыт.
|
||||||
|
3. Для корректной работы triage используйте стандартные лейблы из `.github/labels.md`.
|
||||||
|
|
||||||
|
## Как сообщать о проблемах
|
||||||
|
|
||||||
|
- Используйте шаблон `Проблема`.
|
||||||
|
- По возможности укажите:
|
||||||
|
- версию приложения,
|
||||||
|
- ОС,
|
||||||
|
- шаги воспроизведения,
|
||||||
|
- ожидаемое и фактическое поведение,
|
||||||
|
- лог-файл или текст ошибки.
|
||||||
|
|
||||||
|
Чем точнее описание, тем быстрее можно помочь.
|
||||||
|
|
||||||
|
## Локальный запуск из исходников
|
||||||
|
|
||||||
|
Требуется Python `>=3.8`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
```
|
||||||
|
|
||||||
|
Запуск:
|
||||||
|
|
||||||
|
- консольный режим: `tg-ws-proxy`
|
||||||
|
- Windows tray: `tg-ws-proxy-tray-win`
|
||||||
|
- macOS tray: `tg-ws-proxy-tray-macos`
|
||||||
|
- Linux tray: `tg-ws-proxy-tray-linux`
|
||||||
|
|
||||||
|
Подробности: `docs/BuildFromSource.md`.
|
||||||
|
|
||||||
|
## Pull Request
|
||||||
|
|
||||||
|
Перед открытием PR:
|
||||||
|
|
||||||
|
1. Убедитесь, что изменение решает конкретную проблему.
|
||||||
|
2. Проверьте, что не сломаны существующие сценарии.
|
||||||
|
3. Обновите документацию, если меняется поведение или настройка.
|
||||||
|
|
||||||
|
Небольшие и сфокусированные PR проверяются и принимаются быстрее.
|
||||||
75
docs/BuildFromSource.md
Normal file
75
docs/BuildFromSource.md
Normal file
@@ -0,0 +1,75 @@
|
|||||||
|
# Установка из исходников
|
||||||
|
|
||||||
|
## Консольный прокси
|
||||||
|
|
||||||
|
Для запуска только прокси без интерфейса системного трея достаточно базовой установки:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy
|
||||||
|
```
|
||||||
|
|
||||||
|
## Tray-приложение по ОС
|
||||||
|
|
||||||
|
### Windows 7/10+
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-win
|
||||||
|
```
|
||||||
|
|
||||||
|
### macOS
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-macos
|
||||||
|
```
|
||||||
|
|
||||||
|
### Linux
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-linux
|
||||||
|
```
|
||||||
|
|
||||||
|
## Консольный режим из исходников
|
||||||
|
|
||||||
|
```bash
|
||||||
|
tg-ws-proxy [--port PORT] [--host HOST] [--dc-ip DC:IP ...] [-v]
|
||||||
|
```
|
||||||
|
|
||||||
|
**Аргументы:**
|
||||||
|
|
||||||
|
| Аргумент | По умолчанию | Описание |
|
||||||
|
|---|---|---|
|
||||||
|
| `--port` | `1443` | Порт прокси |
|
||||||
|
| `--host` | `127.0.0.1` | Хост прокси |
|
||||||
|
| `--secret` | `random` | 32-значный hex-ключ для авторизации клиентов |
|
||||||
|
| `--dc-ip` | `2:149.154.167.220`, `4:149.154.167.220` | Целевой IP для DC (параметр можно указывать несколько раз) |
|
||||||
|
| `--no-cfproxy` | `false` | Отключить попытку [проксирования через Cloudflare](./CfProxy.md) |
|
||||||
|
| `--cfproxy-domain` | | Указать свой домен для проксирования через Cloudflare. [Подробнее](./CfProxy.md) |
|
||||||
|
| `--cfproxy-priority` | `true` | Пробовать проксировать через Cloudflare перед прямым TCP подключением |
|
||||||
|
| `--fake-tls-domain` | | Включить маскировку Fake TLS (ee-secret) с указанным SNI-доменом |
|
||||||
|
| `--proxy-protocol` | выкл. | Принимать HAProxy PROXY protocol v1 (для работы за nginx/haproxy с `proxy_protocol on`) |
|
||||||
|
| `--buf-kb` | `256` | Размер буфера в КБ |
|
||||||
|
| `--pool-size` | `4` | Количество заготовленных соединений на каждый DC |
|
||||||
|
| `--log-file` | выкл. | Путь к файлу, в который будут сохраняться логи |
|
||||||
|
| `--log-max-mb` | `5` | Максимальный размер файла логов в МБ (после этого начинается перезапись) |
|
||||||
|
| `--log-backups` | `0` | Количество сохранений логов после перезаписи |
|
||||||
|
| `-v`, `--verbose` | выкл. | Подробное логирование (DEBUG) |
|
||||||
|
|
||||||
|
**Примеры:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Стандартный запуск
|
||||||
|
tg-ws-proxy
|
||||||
|
|
||||||
|
# Другой порт и дополнительные DC
|
||||||
|
tg-ws-proxy --port 9050 --dc-ip 1:149.154.175.205 --dc-ip 2:149.154.167.220
|
||||||
|
|
||||||
|
# С подробным логированием
|
||||||
|
tg-ws-proxy -v
|
||||||
|
|
||||||
|
# Fake TLS маскировка (ee-secret)
|
||||||
|
tg-ws-proxy --fake-tls-domain example.com
|
||||||
|
```
|
||||||
@@ -1,18 +1,20 @@
|
|||||||
# Cloudflare Proxy
|
# Cloudflare-прокси
|
||||||
|
|
||||||
Для недоступных датацентров можно использовать альтернативный бесплатный метод подключения - проксирование через Cloudflare. **Для работы нужен только домен**. В приложении есть домен по умолчанию, но его можно (и лучше) заменить на свой.
|
Для недоступных дата-центров можно использовать альтернативный бесплатный способ подключения — проксирование через Cloudflare. **Для работы нужен только домен**. В приложении есть домен по умолчанию, но его можно (и желательно) заменить на свой.
|
||||||
|
|
||||||
Прокси возвращает доступ к тому, что до этого не грузило (реакциям, некоторым стикерам). Если у вас до этого не грузило видео/фото на аккаунте без премиума, то уберите всё кроме `4:149.154.167.220` из `DC->IP` блока в настройках. Если CF-прокси у вас работает - медиа снова начнёт грузиться.
|
Прокси возвращает доступ к тому, что раньше не загружалось (реакции, некоторые стикеры). Если на аккаунте без Premium не загружаются фото/видео, оставьте в блоке `DC → IP` только `4:149.154.167.220`. Если CF-прокси работает, медиа снова начнет загружаться.
|
||||||
|
|
||||||
## Зачем мне настраивать свой домен?
|
## Зачем мне настраивать свой домен?
|
||||||
Cloudflare имеет лимиты на одновременное количество подключений WS. Домен по умолчанию может перестать работать в любой момент.
|
|
||||||
|
Cloudflare имеет лимиты на одновременное количество WS-подключений. Домен по умолчанию может перестать работать в любой момент.
|
||||||
|
|
||||||
## Настройка своего домена
|
## Настройка своего домена
|
||||||
1. Добавьте свой домен в Cloudflare (либо купив у них напрямую, либо поменяв NS сервера: https://developers.cloudflare.com/dns/zone-setups/full-setup/setup/). Домены стоят +- 150 рублей на год, подойдёт любой.
|
|
||||||
|
|
||||||
2. В `SSL/TLS` -> `Overview` выставьте режим **Flexible**
|
1. Добавьте свой домен в Cloudflare (либо купив его напрямую у Cloudflare, либо изменив NS-серверы: https://developers.cloudflare.com/dns/zone-setups/full-setup/setup/). Домены стоят примерно 150 рублей в год, подойдёт любой.
|
||||||
|
|
||||||
3. В `DNS` -> `Records` добавьте следующие `A` записи через `+ Add Record`:
|
2. В `SSL/TLS` → `Overview` выставьте режим **Flexible**.
|
||||||
|
|
||||||
|
3. В `DNS` → `Records` добавьте следующие `A`-записи через `+ Add Record`:
|
||||||
- Name=`kws1` IPv4=`149.154.175.50`
|
- Name=`kws1` IPv4=`149.154.175.50`
|
||||||
- Name=`kws2` IPv4=`149.154.167.51`
|
- Name=`kws2` IPv4=`149.154.167.51`
|
||||||
- Name=`kws3` IPv4=`149.154.175.100`
|
- Name=`kws3` IPv4=`149.154.175.100`
|
||||||
@@ -20,10 +22,11 @@ Cloudflare имеет лимиты на одновременное количе
|
|||||||
- Name=`kws5` IPv4=`149.154.171.5`
|
- Name=`kws5` IPv4=`149.154.171.5`
|
||||||
- Name=`kws203` IPv4=`91.105.192.100`
|
- Name=`kws203` IPv4=`91.105.192.100`
|
||||||
|
|
||||||
4. **Добавьте домен в [zapret](https://github.com/Flowseal/zapret-discord-youtube/) или в любое другое ПО, так как подсеть Cloudflare забанена (по крайней мере, если вы из России)**
|
4. **Добавьте домен в [zapret](https://github.com/Flowseal/zapret-discord-youtube/) или в любое другое ПО, так как подсеть Cloudflare может быть заблокирована (например, в России).**
|
||||||
|
|
||||||
5. В настройках TgWsProxy поменяйте домен на свой
|
5. В настройках `TgWsProxy` замените домен на свой.
|
||||||
|
|
||||||
## Mentions
|
## Благодарности
|
||||||
Idea - https://github.com/Nekogram/WSProxy
|
|
||||||
Thanks to [@UjuiUjuMandan](https://github.com/UjuiUjuMandan) for the information
|
- Идея: https://github.com/Nekogram/WSProxy
|
||||||
|
- Спасибо [@UjuiUjuMandan](https://github.com/UjuiUjuMandan) за информацию.
|
||||||
52
docs/FakeTlsNginx.md
Normal file
52
docs/FakeTlsNginx.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# Fake TLS + upstream в nginx
|
||||||
|
|
||||||
|
Домен в параметре `--fake-tls-domain` должен указывать на тот же IP, на котором запущен прокси.
|
||||||
|
|
||||||
|
## Пример `nginx.conf` для stream-модуля
|
||||||
|
|
||||||
|
```nginx
|
||||||
|
upstream mtproto {
|
||||||
|
server 127.0.0.1:8446;
|
||||||
|
}
|
||||||
|
|
||||||
|
map $ssl_preread_server_name $sni_name {
|
||||||
|
hostnames;
|
||||||
|
example.com mtproto;
|
||||||
|
# if you have xray with selfsni running:
|
||||||
|
# sub.example.com www;
|
||||||
|
# default xray;
|
||||||
|
}
|
||||||
|
|
||||||
|
# upstream xray {
|
||||||
|
# server 127.0.0.1:8443;
|
||||||
|
# }
|
||||||
|
#
|
||||||
|
# upstream www {
|
||||||
|
# server 127.0.0.1:7443;
|
||||||
|
# }
|
||||||
|
|
||||||
|
server {
|
||||||
|
proxy_protocol on;
|
||||||
|
set_real_ip_from unix:;
|
||||||
|
listen 443;
|
||||||
|
proxy_pass $sni_name;
|
||||||
|
ssl_preread on;
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Запуск прокси за Nginx
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python3 proxy/tg_ws_proxy.py \
|
||||||
|
--port 8446 \
|
||||||
|
--host 127.0.0.1 \
|
||||||
|
--fake-tls-domain example.com \
|
||||||
|
--proxy-protocol \
|
||||||
|
--secret <32-hex-chars>
|
||||||
|
```
|
||||||
|
|
||||||
|
Ссылка для подключения будет в формате `ee`-секрета:
|
||||||
|
|
||||||
|
```text
|
||||||
|
tg://proxy?server=your.domain.com&port=443&secret=ee<secret><domain_hex>
|
||||||
|
```
|
||||||
@@ -7,8 +7,6 @@
|
|||||||
> **ETH**: `0x1417878fdc5047E670a77748B34819b9A49C72F1`
|
> **ETH**: `0x1417878fdc5047E670a77748B34819b9A49C72F1`
|
||||||
> **Другие монеты**: https://nowpayments.io/donation/flowseal
|
> **Другие монеты**: https://nowpayments.io/donation/flowseal
|
||||||
|
|
||||||
##
|
Проект полностью бесплатен для всех.
|
||||||
|
Однако его развитие и стабильная работа при росте числа пользователей требуют вложений.
|
||||||
### Проект полностью бесплатен для использования всеми.
|
Буду благодарен за любую форму поддержки! Спасибо ❤️
|
||||||
### Однако его развитие и стабильная работа при росте числа пользователей требуют от меня определённых вложений.
|
|
||||||
### Буду благодарен за любую форму поддержки! Спасибо ❤️
|
|
||||||
51
docs/README.linux.md
Normal file
51
docs/README.linux.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
# TG WS Proxy для Linux
|
||||||
|
|
||||||
|
## Готовые сборки
|
||||||
|
|
||||||
|
Для Debian/Ubuntu скачайте со [страницы релизов](https://github.com/Flowseal/tg-ws-proxy/releases) пакет `TgWsProxy_linux_amd64.deb`.
|
||||||
|
|
||||||
|
Для Arch и основанных на Arch дистрибутивов подготовлены пакеты в AUR:
|
||||||
|
|
||||||
|
- [tg-ws-proxy-bin](https://aur.archlinux.org/packages/tg-ws-proxy-bin)
|
||||||
|
- [tg-ws-proxy-git](https://aur.archlinux.org/packages/tg-ws-proxy-git)
|
||||||
|
- [tg-ws-proxy-cli](https://aur.archlinux.org/packages/tg-ws-proxy-cli)
|
||||||
|
|
||||||
|
```shell
|
||||||
|
# Установка без AUR-helper
|
||||||
|
git clone https://aur.archlinux.org/tg-ws-proxy-bin.git
|
||||||
|
cd tg-ws-proxy-bin
|
||||||
|
makepkg -si
|
||||||
|
|
||||||
|
# При помощи AUR-helper
|
||||||
|
paru -S tg-ws-proxy-bin
|
||||||
|
|
||||||
|
# Для пакета -cli запуск через systemd (8888 — номер порта; secret можно сгенерировать командой openssl rand -hex 16)
|
||||||
|
sudo systemctl start tg-ws-proxy@8888:3075abe65830f0325116bb0416cadf9f
|
||||||
|
```
|
||||||
|
|
||||||
|
Для остальных дистрибутивов можно использовать `TgWsProxy_linux_amd64` (бинарный файл для x86_64).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
chmod +x TgWsProxy_linux_amd64
|
||||||
|
./TgWsProxy_linux_amd64
|
||||||
|
```
|
||||||
|
|
||||||
|
При первом запуске откроется окно с инструкцией. Приложение работает в системном трее (требуется AppIndicator).
|
||||||
|
|
||||||
|
## Настройка Telegram Desktop
|
||||||
|
|
||||||
|
1. Telegram → **Настройки** → **Продвинутые настройки** → **Тип подключения** → **Прокси**
|
||||||
|
2. Добавьте прокси:
|
||||||
|
- **Тип:** MTProto
|
||||||
|
- **Сервер:** `127.0.0.1` (или переопределенный вами)
|
||||||
|
- **Порт:** `1443` (или переопределенный вами)
|
||||||
|
- **Secret:** из настроек или логов
|
||||||
|
|
||||||
|
## Установка из исходников
|
||||||
|
|
||||||
|
Подробная инструкция: [BuildFromSource.md](./BuildFromSource.md)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-linux
|
||||||
|
```
|
||||||
30
docs/README.macos.md
Normal file
30
docs/README.macos.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# TG WS Proxy для macOS
|
||||||
|
|
||||||
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте `TgWsProxy_macos_universal.dmg` (универсальная сборка для Apple Silicon и Intel).
|
||||||
|
|
||||||
|
1. Откройте образ
|
||||||
|
2. Перенесите `TG WS Proxy.app` в папку `Applications`
|
||||||
|
3. При первом запуске macOS может попросить подтвердить открытие: **Системные настройки → Конфиденциальность и безопасность → Всё равно открыть**
|
||||||
|
|
||||||
|
Минимально поддерживаемые версии:
|
||||||
|
|
||||||
|
- Intel macOS 10.15+
|
||||||
|
- Apple Silicon macOS 11.0+
|
||||||
|
|
||||||
|
## Настройка Telegram Desktop
|
||||||
|
|
||||||
|
1. Telegram → **Настройки** → **Продвинутые настройки** → **Тип подключения** → **Прокси**
|
||||||
|
2. Добавьте прокси:
|
||||||
|
- **Тип:** MTProto
|
||||||
|
- **Сервер:** `127.0.0.1` (или переопределенный вами)
|
||||||
|
- **Порт:** `1443` (или переопределенный вами)
|
||||||
|
- **Secret:** из настроек или логов
|
||||||
|
|
||||||
|
## Установка из исходников
|
||||||
|
|
||||||
|
Подробная инструкция: [BuildFromSource.md](./BuildFromSource.md)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-macos
|
||||||
|
```
|
||||||
306
docs/README.md
306
docs/README.md
@@ -1,6 +1,6 @@
|
|||||||
> [!TIP]
|
> [!TIP]
|
||||||
>
|
>
|
||||||
> ### [🎉 Поддержать меня](https://github.com/Flowseal/tg-ws-proxy/blob/main/docs/Funding.md)
|
> ### [🎉 Поддержать меня](./Funding.md)
|
||||||
>
|
>
|
||||||
> **USDT (TRC20)**: `TXPnKs2Ww1RD8JN6nChFUVmi5r2hqrWjuu`
|
> **USDT (TRC20)**: `TXPnKs2Ww1RD8JN6nChFUVmi5r2hqrWjuu`
|
||||||
> **BTC**: `bc1qr8vd6jelkyyry3m4mq6z5txdx4pl856fu6ss0w`
|
> **BTC**: `bc1qr8vd6jelkyyry3m4mq6z5txdx4pl856fu6ss0w`
|
||||||
@@ -14,7 +14,7 @@
|
|||||||
> Антивирусы часто ошибочно помечают приложение как вирус из-за упаковщика.
|
> Антивирусы часто ошибочно помечают приложение как вирус из-за упаковщика.
|
||||||
> Если вы не можете скачать из-за блокировки антивирусом, то:
|
> Если вы не можете скачать из-за блокировки антивирусом, то:
|
||||||
>
|
>
|
||||||
> 1) **Попробуйте скачать версию win7 (она ничем не отличается в плане функционала)**
|
> 1) **Попробуйте скачать версию для Windows 7 (по функциональности она не отличается)**
|
||||||
> 2) Отключите антивирус на время скачивания, добавьте файл в исключения и включите обратно
|
> 2) Отключите антивирус на время скачивания, добавьте файл в исключения и включите обратно
|
||||||
>
|
>
|
||||||
> Всегда проверяйте, что скачиваете из интернета, тем более из непроверенных источников. Всегда лучше смотреть на детекты широко известных антивирусов на VirusTotal
|
> Всегда проверяйте, что скачиваете из интернета, тем более из непроверенных источников. Всегда лучше смотреть на детекты широко известных антивирусов на VirusTotal
|
||||||
@@ -28,6 +28,58 @@
|
|||||||
<img src="https://github.com/user-attachments/assets/8d595468-83a1-4e4f-bac4-9ce4a07027bd">
|
<img src="https://github.com/user-attachments/assets/8d595468-83a1-4e4f-bac4-9ce4a07027bd">
|
||||||
</picture>
|
</picture>
|
||||||
|
|
||||||
|
## Навигация
|
||||||
|
|
||||||
|
- **🚀 Быстрый старт**
|
||||||
|
- **[Windows](./README.windows.md)**
|
||||||
|
- **[macOS](./README.macos.md)**
|
||||||
|
- **[Linux](./README.linux.md)**
|
||||||
|
- [Настройка Cloudflare-домена (CF-прокси)](./CfProxy.md)
|
||||||
|
- [Fake TLS + upstream в Nginx](./FakeTlsNginx.md)
|
||||||
|
- [Файлы конфигурации Tray-приложения](./TrayConfig.md)
|
||||||
|
- [Установка из исходников](./BuildFromSource.md)
|
||||||
|
- [Руководство для контрибьюторов](../CONTRIBUTING.md)
|
||||||
|
|
||||||
|
## Windows: быстрый вход
|
||||||
|
|
||||||
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте:
|
||||||
|
|
||||||
|
- `TgWsProxy_windows.exe` (Windows 10+)
|
||||||
|
- `TgWsProxy_windows_7_64bit.exe` (Windows 7 x64)
|
||||||
|
- `TgWsProxy_windows_7_32bit.exe` (Windows 7 x32)
|
||||||
|
|
||||||
|
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
||||||
|
|
||||||
|
### Меню трея
|
||||||
|
|
||||||
|
- **Открыть в Telegram** — автоматически настроить прокси через ссылку `tg://proxy`
|
||||||
|
- **Скопировать ссылку** — скопировать ссылку для подключения
|
||||||
|
- **Перезапустить прокси** — перезапуск без выхода из приложения
|
||||||
|
- **Настройки...** — GUI-редактор конфигурации (версия приложения, опциональная проверка обновлений с GitHub)
|
||||||
|
- **Открыть логи** — открыть файл логов
|
||||||
|
- **Выход** — остановить прокси и закрыть приложение
|
||||||
|
|
||||||
|
### Настройка Telegram Desktop
|
||||||
|
|
||||||
|
**Автоматическая настройка**
|
||||||
|
|
||||||
|
Щелкните правой кнопкой мыши по значку в трее и выберите **«Открыть в Telegram»**.
|
||||||
|
|
||||||
|
Если не сработало (Telegram не открылся с подключением), выполните шаги ниже:
|
||||||
|
|
||||||
|
1. Щелкните правой кнопкой мыши по значку в трее и выберите **«Скопировать ссылку»**
|
||||||
|
2. Отправьте ссылку в «Избранное» в Telegram и нажмите по ней левой кнопкой мыши
|
||||||
|
3. Подключитесь
|
||||||
|
|
||||||
|
**Ручная настройка**
|
||||||
|
|
||||||
|
1. Telegram → **Настройки** → **Продвинутые настройки** → **Тип подключения** → **Прокси**
|
||||||
|
2. Добавьте прокси:
|
||||||
|
- **Тип:** MTProto
|
||||||
|
- **Сервер:** `127.0.0.1` (или переопределенный вами)
|
||||||
|
- **Порт:** `1443` (или переопределенный вами)
|
||||||
|
- **Secret:** из настроек или логов
|
||||||
|
|
||||||
## Как это работает
|
## Как это работает
|
||||||
|
|
||||||
```
|
```
|
||||||
@@ -42,244 +94,10 @@ Telegram Desktop → MTProto Proxy (127.0.0.1:1443) → WebSocket → Telegram D
|
|||||||
|
|
||||||
> [!IMPORTANT]
|
> [!IMPORTANT]
|
||||||
> ### Не грузит фото/видео?
|
> ### Не грузит фото/видео?
|
||||||
> **Удалите в настройках прокси в DC->IP всё, кроме `4:149.154.167.220`**
|
> **Удалите в настройках прокси в DC → IP всё, кроме `4:149.154.167.220`**
|
||||||
> **Если не помогло, то полностью очистите это поле**
|
> **Если это не помогло, полностью очистите это поле**
|
||||||
> ####
|
|
||||||
> Подобная проблема встречается на аккаунтах без Premium
|
> Подобная проблема встречается на аккаунтах без Premium
|
||||||
> Если вам не помогло, то настраивайте свой домен по гайду отсюда: https://github.com/Flowseal/tg-ws-proxy/blob/main/docs/CfProxy.md
|
> Если это не помогло, настройте собственный домен по инструкции: [CfProxy.md](./CfProxy.md)
|
||||||
|
|
||||||
## 🚀 Быстрый старт
|
|
||||||
|
|
||||||
### Windows
|
|
||||||
|
|
||||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy_windows.exe`**. Он собирается автоматически через [GitHub Actions](https://github.com/Flowseal/tg-ws-proxy/actions) из открытого исходного кода.
|
|
||||||
|
|
||||||
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
|
||||||
|
|
||||||
**Меню трея:**
|
|
||||||
|
|
||||||
- **Открыть в Telegram** — автоматически настроить прокси через ссылку `tg://proxy`
|
|
||||||
- **Скопировать ссылку** — скопировать ссылку для подключения
|
|
||||||
- **Перезапустить прокси** — перезапуск без выхода из приложения
|
|
||||||
- **Настройки...** — GUI-редактор конфигурации (версия приложения, опциональная проверка обновлений с GitHub)
|
|
||||||
- **Открыть логи** — открыть файл логов
|
|
||||||
- **Выход** — остановить прокси и закрыть приложение
|
|
||||||
|
|
||||||
При первом запуске после старта может появиться запрос об открытии страницы релиза, если на GitHub вышла новая версия (эту проверку можно отключить в настройках).
|
|
||||||
|
|
||||||
### Настройка Telegram Desktop
|
|
||||||
|
|
||||||
### Автоматически:
|
|
||||||
|
|
||||||
ПКМ по иконке в трее → **«Открыть в Telegram»**
|
|
||||||
Если не сработало (не открылся Telegram с подключением), то:
|
|
||||||
1. ПКМ по иконке в трее → **«Скопировать ссылку»**
|
|
||||||
2. Отправьте ссылку себе в избранное в Telegram-клиенте и нажмите по ней ЛКМ
|
|
||||||
3. Подключитесь
|
|
||||||
|
|
||||||
### Вручную:
|
|
||||||
|
|
||||||
1. Telegram → **Настройки** → **Продвинутые настройки** → **Тип подключения** → **Прокси**
|
|
||||||
2. Добавить прокси:
|
|
||||||
- **Тип:** MTProto
|
|
||||||
- **Сервер:** `127.0.0.1` (или переопределенный вами)
|
|
||||||
- **Порт:** `1443` (или переопределенный вами)
|
|
||||||
- **Secret:** из настроек или логов
|
|
||||||
|
|
||||||
##
|
|
||||||
### macOS
|
|
||||||
|
|
||||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy_macos_universal.dmg`** — универсальная сборка для Apple Silicon и Intel.
|
|
||||||
|
|
||||||
1. Открыть образ
|
|
||||||
2. Перенести **TG WS Proxy.app** в папку **Applications**
|
|
||||||
3. При первом запуске macOS может попросить подтвердить открытие: **Системные настройки → Конфиденциальность и безопасность → Всё равно открыть**
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
Для Debian/Ubuntu скачайте со [страницы релизов](https://github.com/Flowseal/tg-ws-proxy/releases) пакет **`TgWsProxy_linux_amd64.deb`**.
|
|
||||||
|
|
||||||
Для Arch и Arch-based дистрибутивов подготовлены пакеты в AUR: [tg-ws-proxy-bin](https://aur.archlinux.org/packages/tg-ws-proxy-bin), [tg-ws-proxy-git](https://aur.archlinux.org/packages/tg-ws-proxy-git), [tg-ws-proxy-cli](https://aur.archlinux.org/packages/tg-ws-proxy-cli)
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# Установка без AUR-helper
|
|
||||||
git clone https://aur.archlinux.org/tg-ws-proxy-bin.git
|
|
||||||
cd tg-ws-proxy-bin
|
|
||||||
makepkg -si
|
|
||||||
|
|
||||||
# При помощи AUR-helper
|
|
||||||
paru -S tg-ws-proxy-bin
|
|
||||||
|
|
||||||
# Если вы установили -cli пакет, то запуск осуществляется через systemctl, где 8888 - это номер порта,
|
|
||||||
# разделитель ":" и secret, который можно сгенерировать командой: openssl rand -hex 16
|
|
||||||
sudo systemctl start tg-ws-proxy@8888:3075abe65830f0325116bb0416cadf9f
|
|
||||||
```
|
|
||||||
|
|
||||||
Для остальных дистрибутивов можно использовать **`TgWsProxy_linux_amd64`** (бинарный файл для x86_64).
|
|
||||||
|
|
||||||
```bash
|
|
||||||
chmod +x TgWsProxy_linux_amd64
|
|
||||||
./TgWsProxy_linux_amd64
|
|
||||||
```
|
|
||||||
|
|
||||||
При первом запуске откроется окно с инструкцией. Приложение работает в системном трее (требуется AppIndicator).
|
|
||||||
|
|
||||||
## Установка из исходников
|
|
||||||
|
|
||||||
### Консольный proxy
|
|
||||||
|
|
||||||
Для запуска только proxy без tray-интерфейса достаточно базовой установки:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install -e .
|
|
||||||
tg-ws-proxy
|
|
||||||
```
|
|
||||||
|
|
||||||
### Windows 7/10+
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install -e .
|
|
||||||
tg-ws-proxy-tray-win
|
|
||||||
```
|
|
||||||
|
|
||||||
### macOS
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install -e .
|
|
||||||
tg-ws-proxy-tray-macos
|
|
||||||
```
|
|
||||||
|
|
||||||
### Linux
|
|
||||||
|
|
||||||
```bash
|
|
||||||
pip install -e .
|
|
||||||
tg-ws-proxy-tray-linux
|
|
||||||
```
|
|
||||||
|
|
||||||
### Консольный режим из исходников
|
|
||||||
|
|
||||||
```bash
|
|
||||||
tg-ws-proxy [--port PORT] [--host HOST] [--dc-ip DC:IP ...] [-v]
|
|
||||||
```
|
|
||||||
|
|
||||||
**Аргументы:**
|
|
||||||
|
|
||||||
| Аргумент | По умолчанию | Описание |
|
|
||||||
|---|---|---|
|
|
||||||
| `--port` | `1443` | Порт прокси |
|
|
||||||
| `--host` | `127.0.0.1` | Хост прокси |
|
|
||||||
| `--secret` | `random` | 32-значный hex-ключ для авторизации клиентов |
|
|
||||||
| `--dc-ip` | `2:149.154.167.220`, `4:149.154.167.220` | Целевой IP для DC (можно указать несколько раз) |
|
|
||||||
| `--no-cfproxy` | `false` | Отключить попытку [проксирования через Cloudflare](https://github.com/Flowseal/tg-ws-proxy/blob/main/docs/CfProxy.md) |
|
|
||||||
| `--cfproxy-domain` | | Указать свой домен для проксирования через Cloudflare. [Подробнее тут](https://github.com/Flowseal/tg-ws-proxy/blob/main/docs/CfProxy.md) |
|
|
||||||
| `--cfproxy-priority` | `true` | Пробовать проксировать через Cloudflare перед прямым TCP подключением |
|
|
||||||
| `--fake-tls-domain` | | Включить Fake TLS (ee-secret) маскировку с указанным SNI-доменом |
|
|
||||||
| `--proxy-protocol` | выкл. | Принимать HAProxy PROXY protocol v1 (для работы за nginx/haproxy с `proxy_protocol on`) |
|
|
||||||
| `--buf-kb` | `256` | Размер буфера в КБ |
|
|
||||||
| `--pool-size` | `4` | Количество заготовленных соединений на каждый DC |
|
|
||||||
| `--log-file` | выкл. | Путь к файлу, в который будут сохраняться логи |
|
|
||||||
| `--log-max-mb` | `5` | Максимальный размер файла логов в МБ (после идёт перезапись) |
|
|
||||||
| `--log-backups` | `0` | Количество сохранений логов после перезаписи |
|
|
||||||
| `-v`, `--verbose` | выкл. | Подробное логирование (DEBUG) |
|
|
||||||
|
|
||||||
**Примеры:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
# Стандартный запуск
|
|
||||||
tg-ws-proxy
|
|
||||||
|
|
||||||
# Другой порт и дополнительные DC
|
|
||||||
tg-ws-proxy --port 9050 --dc-ip 1:149.154.175.205 --dc-ip 2:149.154.167.220
|
|
||||||
|
|
||||||
# С подробным логированием
|
|
||||||
tg-ws-proxy -v
|
|
||||||
|
|
||||||
# Fake TLS маскировка (ee-secret)
|
|
||||||
tg-ws-proxy --fake-tls-domain example.com
|
|
||||||
```
|
|
||||||
|
|
||||||
## Fake TLS + nginx upstream
|
|
||||||
### Домен (`--fake-tls-domain`) должен указывать на тот же IP, на котором стоит прокси
|
|
||||||
|
|
||||||
**Пример `nginx.conf` (stream):**
|
|
||||||
|
|
||||||
```nginx
|
|
||||||
upstream mtproto {
|
|
||||||
server 127.0.0.1:8446;
|
|
||||||
}
|
|
||||||
|
|
||||||
map $ssl_preread_server_name $sni_name {
|
|
||||||
hostnames;
|
|
||||||
example.com mtproto;
|
|
||||||
# if you have xray with selfsni running:
|
|
||||||
# sub.example.com www;
|
|
||||||
# default xray;
|
|
||||||
}
|
|
||||||
|
|
||||||
# upstream xray {
|
|
||||||
# server 127.0.0.1:8443;
|
|
||||||
# }
|
|
||||||
#
|
|
||||||
# upstream www {
|
|
||||||
# server 127.0.0.1:7443;
|
|
||||||
# }
|
|
||||||
|
|
||||||
server {
|
|
||||||
proxy_protocol on;
|
|
||||||
set_real_ip_from unix:;
|
|
||||||
listen 443;
|
|
||||||
proxy_pass $sni_name;
|
|
||||||
ssl_preread on;
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
**Запуск прокси за nginx:**
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 proxy/tg_ws_proxy.py \
|
|
||||||
--port 8446 \
|
|
||||||
--host 127.0.0.1 \
|
|
||||||
--fake-tls-domain example.com \
|
|
||||||
--proxy-protocol \
|
|
||||||
--secret <32-hex-chars>
|
|
||||||
```
|
|
||||||
|
|
||||||
Ссылка для подключения будет в формате `ee`-секрета:
|
|
||||||
|
|
||||||
```
|
|
||||||
tg://proxy?server=your.domain.com&port=443&secret=ee<secret><domain_hex>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Файлы конфигурации Tray-приложения
|
|
||||||
|
|
||||||
Tray-приложение хранит данные в:
|
|
||||||
|
|
||||||
- **Windows:** `%APPDATA%/TgWsProxy`
|
|
||||||
- **macOS:** `~/Library/Application Support/TgWsProxy`
|
|
||||||
- **Linux:** `~/.config/TgWsProxy` (или `$XDG_CONFIG_HOME/TgWsProxy`)
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"host": "127.0.0.1",
|
|
||||||
"port": 1443,
|
|
||||||
"secret": "...",
|
|
||||||
"dc_ip": [
|
|
||||||
"2:149.154.167.220",
|
|
||||||
"4:149.154.167.220"
|
|
||||||
],
|
|
||||||
"verbose": false,
|
|
||||||
"buf_kb": 256,
|
|
||||||
"pool_size": 4,
|
|
||||||
"log_max_mb": 5.0,
|
|
||||||
"check_updates": true,
|
|
||||||
"cfproxy": true,
|
|
||||||
"cfproxy_priority": true,
|
|
||||||
"cfproxy_user_domain": "",
|
|
||||||
"appearance": "auto"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Ключ **`check_updates`** — при `true` при запросе к GitHub сравнивается версия с последним релизом (только уведомление и ссылка на страницу загрузки). На Windows в конфиге может быть **`autostart`** (автозапуск при входе в систему).
|
|
||||||
|
|
||||||
## Автоматическая сборка
|
## Автоматическая сборка
|
||||||
|
|
||||||
@@ -294,6 +112,14 @@ Tray-приложение хранит данные в:
|
|||||||
- Apple Silicon macOS 11.0+
|
- Apple Silicon macOS 11.0+
|
||||||
- Linux x86_64 (требуется AppIndicator для системного трея)
|
- Linux x86_64 (требуется AppIndicator для системного трея)
|
||||||
|
|
||||||
|
## Контрибьюторы
|
||||||
|
|
||||||
|
Спасибо всем, кто помогает развивать проект ❤️
|
||||||
|
|
||||||
|
<a href="https://github.com/Flowseal/tg-ws-proxy/graphs/contributors">
|
||||||
|
<img src="https://contrib.rocks/image?repo=Flowseal/tg-ws-proxy" />
|
||||||
|
</a>
|
||||||
|
|
||||||
## Лицензия
|
## Лицензия
|
||||||
|
|
||||||
[MIT License](https://github.com/Flowseal/tg-ws-proxy/blob/main/LICENSE)
|
[MIT License](../LICENSE)
|
||||||
|
|||||||
52
docs/README.windows.md
Normal file
52
docs/README.windows.md
Normal file
@@ -0,0 +1,52 @@
|
|||||||
|
# TG WS Proxy для Windows
|
||||||
|
|
||||||
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте:
|
||||||
|
|
||||||
|
- `TgWsProxy_windows.exe` (Windows 10+)
|
||||||
|
- `TgWsProxy_windows_7_64bit.exe` (Windows 7 x64)
|
||||||
|
- `TgWsProxy_windows_7_32bit.exe` (Windows 7 x32)
|
||||||
|
|
||||||
|
Сборки публикуются автоматически через [GitHub Actions](https://github.com/Flowseal/tg-ws-proxy/actions) из открытого исходного кода.
|
||||||
|
|
||||||
|
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
||||||
|
|
||||||
|
## Меню трея
|
||||||
|
|
||||||
|
- **Открыть в Telegram** — автоматически настроить прокси через ссылку `tg://proxy`
|
||||||
|
- **Скопировать ссылку** — скопировать ссылку для подключения
|
||||||
|
- **Перезапустить прокси** — перезапуск без выхода из приложения
|
||||||
|
- **Настройки...** — GUI-редактор конфигурации (версия приложения, опциональная проверка обновлений с GitHub)
|
||||||
|
- **Открыть логи** — открыть файл логов
|
||||||
|
- **Выход** — остановить прокси и закрыть приложение
|
||||||
|
|
||||||
|
При первом запуске после старта может появиться запрос об открытии страницы релиза, если на GitHub вышла новая версия (эту проверку можно отключить в настройках).
|
||||||
|
|
||||||
|
## Настройка Telegram Desktop
|
||||||
|
|
||||||
|
### Автоматическая настройка
|
||||||
|
|
||||||
|
Щелкните правой кнопкой мыши по значку в трее и выберите **«Открыть в Telegram»**.
|
||||||
|
|
||||||
|
Если не сработало (Telegram не открылся с подключением), выполните шаги ниже:
|
||||||
|
|
||||||
|
1. Щелкните правой кнопкой мыши по значку в трее и выберите **«Скопировать ссылку»**
|
||||||
|
2. Отправьте ссылку в «Избранное» в Telegram и нажмите по ней левой кнопкой мыши
|
||||||
|
3. Подключитесь
|
||||||
|
|
||||||
|
### Ручная настройка
|
||||||
|
|
||||||
|
1. Telegram → **Настройки** → **Продвинутые настройки** → **Тип подключения** → **Прокси**
|
||||||
|
2. Добавьте прокси:
|
||||||
|
- **Тип:** MTProto
|
||||||
|
- **Сервер:** `127.0.0.1` (или переопределенный вами)
|
||||||
|
- **Порт:** `1443` (или переопределенный вами)
|
||||||
|
- **Secret:** из настроек или логов
|
||||||
|
|
||||||
|
## Установка из исходников
|
||||||
|
|
||||||
|
Подробная инструкция: [BuildFromSource.md](./BuildFromSource.md)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pip install -e .
|
||||||
|
tg-ws-proxy-tray-win
|
||||||
|
```
|
||||||
31
docs/TrayConfig.md
Normal file
31
docs/TrayConfig.md
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
# Файлы конфигурации Tray-приложения
|
||||||
|
|
||||||
|
Tray-приложение хранит данные в:
|
||||||
|
|
||||||
|
- **Windows:** `%APPDATA%/TgWsProxy`
|
||||||
|
- **macOS:** `~/Library/Application Support/TgWsProxy`
|
||||||
|
- **Linux:** `~/.config/TgWsProxy` (или `$XDG_CONFIG_HOME/TgWsProxy`)
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"host": "127.0.0.1",
|
||||||
|
"port": 1443,
|
||||||
|
"secret": "...",
|
||||||
|
"dc_ip": [
|
||||||
|
"2:149.154.167.220",
|
||||||
|
"4:149.154.167.220"
|
||||||
|
],
|
||||||
|
"verbose": false,
|
||||||
|
"buf_kb": 256,
|
||||||
|
"pool_size": 4,
|
||||||
|
"log_max_mb": 5.0,
|
||||||
|
"check_updates": true,
|
||||||
|
"cfproxy": true,
|
||||||
|
"cfproxy_priority": true,
|
||||||
|
"cfproxy_user_domain": "",
|
||||||
|
"appearance": "auto"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Ключ `check_updates`: при `true` выполняется запрос к GitHub и сравнение текущей версии с последним релизом (только уведомление и ссылка на страницу загрузки).
|
||||||
|
На Windows в конфиге может быть `autostart` (автозапуск при входе в систему).
|
||||||
Reference in New Issue
Block a user