docs: update README.
This commit is contained in:
parent
38d159c723
commit
d660f6a270
|
|
@ -1,8 +1,10 @@
|
||||||
> [!CAUTION]
|
> [!CAUTION]
|
||||||
>
|
>
|
||||||
> ### Реакция антивирусов
|
> ### Реакция антивирусов
|
||||||
|
>
|
||||||
> Windows Defender часто ошибочно помечает приложение как **Wacatac**.
|
> Windows Defender часто ошибочно помечает приложение как **Wacatac**.
|
||||||
> Если вы не можете скачать из-за блокировки, то:
|
> Если вы не можете скачать из-за блокировки, то:
|
||||||
|
>
|
||||||
> 1) Попробуйте скачать версию win7 (она ничем не отличается в плане функционала)
|
> 1) Попробуйте скачать версию win7 (она ничем не отличается в плане функционала)
|
||||||
> 2) Отключите антивирус на время скачивания, добавьте файл в исключения и включите обратно
|
> 2) Отключите антивирус на время скачивания, добавьте файл в исключения и включите обратно
|
||||||
>
|
>
|
||||||
|
|
@ -29,11 +31,13 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS → Telegra
|
||||||
## 🚀 Быстрый старт
|
## 🚀 Быстрый старт
|
||||||
|
|
||||||
### Windows
|
### Windows
|
||||||
|
|
||||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy.exe`**. Он собирается автоматически через [Github Actions](https://github.com/Flowseal/tg-ws-proxy/actions) из открытого исходного кода.
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy.exe`**. Он собирается автоматически через [Github Actions](https://github.com/Flowseal/tg-ws-proxy/actions) из открытого исходного кода.
|
||||||
|
|
||||||
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
При первом запуске откроется окно с инструкцией по подключению Telegram Desktop. Приложение сворачивается в системный трей.
|
||||||
|
|
||||||
**Меню трея:**
|
**Меню трея:**
|
||||||
|
|
||||||
- **Открыть в Telegram** — автоматически настроить прокси через `tg://socks` ссылку
|
- **Открыть в Telegram** — автоматически настроить прокси через `tg://socks` ссылку
|
||||||
- **Перезапустить прокси** — перезапуск без выхода из приложения
|
- **Перезапустить прокси** — перезапуск без выхода из приложения
|
||||||
- **Настройки...** — GUI-редактор конфигурации
|
- **Настройки...** — GUI-редактор конфигурации
|
||||||
|
|
@ -41,6 +45,7 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS → Telegra
|
||||||
- **Выход** — остановить прокси и закрыть приложение
|
- **Выход** — остановить прокси и закрыть приложение
|
||||||
|
|
||||||
### macOS
|
### macOS
|
||||||
|
|
||||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy.dmg`** — универсальная сборка для Apple Silicon и Intel.
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy.dmg`** — универсальная сборка для Apple Silicon и Intel.
|
||||||
|
|
||||||
1. Открыть образ
|
1. Открыть образ
|
||||||
|
|
@ -48,6 +53,7 @@ Telegram Desktop → SOCKS5 (127.0.0.1:1080) → TG WS Proxy → WSS → Telegra
|
||||||
3. При первом запуске macOS может попросить подтвердить открытие: **Системные настройки → Конфиденциальность и безопасность → Всё равно открыть**
|
3. При первом запуске macOS может попросить подтвердить открытие: **Системные настройки → Конфиденциальность и безопасность → Всё равно открыть**
|
||||||
|
|
||||||
### Linux
|
### Linux
|
||||||
|
|
||||||
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy`** (бинарный файл для x86_64).
|
Перейдите на [страницу релизов](https://github.com/Flowseal/tg-ws-proxy/releases) и скачайте **`TgWsProxy`** (бинарный файл для x86_64).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -135,6 +141,7 @@ CLI команды объявляются в `pyproject.toml` в секции `[
|
||||||
tg-ws-proxy = "proxy.tg_ws_proxy:main"
|
tg-ws-proxy = "proxy.tg_ws_proxy:main"
|
||||||
tg-ws-proxy-tray-win = "windows:main"
|
tg-ws-proxy-tray-win = "windows:main"
|
||||||
tg-ws-proxy-tray-macos = "macos:main"
|
tg-ws-proxy-tray-macos = "macos:main"
|
||||||
|
tg-ws-proxy-tray-linux = "linux:main"
|
||||||
```
|
```
|
||||||
|
|
||||||
## Настройка Telegram Desktop
|
## Настройка Telegram Desktop
|
||||||
|
|
@ -155,6 +162,7 @@ tg-ws-proxy-tray-macos = "macos:main"
|
||||||
## Конфигурация
|
## Конфигурация
|
||||||
|
|
||||||
Tray-приложение хранит данные в:
|
Tray-приложение хранит данные в:
|
||||||
|
|
||||||
- **Windows:** `%APPDATA%/TgWsProxy`
|
- **Windows:** `%APPDATA%/TgWsProxy`
|
||||||
- **macOS:** `~/Library/Application Support/TgWsProxy`
|
- **macOS:** `~/Library/Application Support/TgWsProxy`
|
||||||
- **Linux:** `~/.config/TgWsProxy` (или `$XDG_CONFIG_HOME/TgWsProxy`)
|
- **Linux:** `~/.config/TgWsProxy` (или `$XDG_CONFIG_HOME/TgWsProxy`)
|
||||||
|
|
@ -175,6 +183,7 @@ Tray-приложение хранит данные в:
|
||||||
Проект содержит спецификации PyInstaller ([`packaging/windows.spec`](packaging/windows.spec), [`packaging/macos.spec`](packaging/macos.spec), [`packaging/linux.spec`](packaging/linux.spec)) и GitHub Actions workflow ([`.github/workflows/build.yml`](.github/workflows/build.yml)) для автоматической сборки.
|
Проект содержит спецификации PyInstaller ([`packaging/windows.spec`](packaging/windows.spec), [`packaging/macos.spec`](packaging/macos.spec), [`packaging/linux.spec`](packaging/linux.spec)) и GitHub Actions workflow ([`.github/workflows/build.yml`](.github/workflows/build.yml)) для автоматической сборки.
|
||||||
|
|
||||||
Минимально поддерживаемые версии ОС для текущих бинарных сборок:
|
Минимально поддерживаемые версии ОС для текущих бинарных сборок:
|
||||||
|
|
||||||
- Windows 10+ для `TgWsProxy.exe`
|
- Windows 10+ для `TgWsProxy.exe`
|
||||||
- Windows 7 для `TgWsProxy-win7.exe`
|
- Windows 7 для `TgWsProxy-win7.exe`
|
||||||
- Intel macOS 10.15+
|
- Intel macOS 10.15+
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue