fix(proxy-client): согласованы инструкции самостоятельной установки
- Зачем: - README смешивал пакетный и корневой установщики и оставлял неполные шаги для отдельных сценариев. - Что: - выстроен цельный путь установки и настройки для standalone и полного dotfiles. - дополнена подсказка --no-shell-setup и добавлена регрессионная проверка. - закрыты критерии приёмки тикета и указана дата завершения. - Проверка: - bash tests/test_proxy_client_install.sh. - bash tests/test_install.sh.
This commit is contained in:
ddadmin committed
1 parent
f679515a8f
commit
623ed8f871
4 files changed
+109
-61
No files matched your search
+93
-47
@@ -10,30 +10,10 @@ CLI требует Python 3.8+ и использует только станда
|
||||
|
||||
## Установка
|
||||
|
||||
### В составе dotfiles
|
||||
|
||||
Полная установка подключает пакет и автоматически загружает Bash-функции в
|
||||
новых интерактивных сессиях:
|
||||
|
||||
```bash
|
||||
cd ~/dotfiles
|
||||
./install.sh
|
||||
```
|
||||
|
||||
Установщик заранее создаёт `~/.local/bin` и `~/.config/proxy-client`, чтобы Stow
|
||||
размещал ссылки внутри них, а не превращал сами каталоги в ссылки на
|
||||
репозиторий.
|
||||
|
||||
После установки откройте новый Bash или выполните:
|
||||
|
||||
```bash
|
||||
source ~/.bash_custom
|
||||
```
|
||||
|
||||
### Только пакет `proxy-client`
|
||||
|
||||
Каталог можно скопировать отдельно от остальных dotfiles и запустить его
|
||||
собственный установщик из любого рабочего каталога:
|
||||
Скопируйте каталог в постоянное место и запустите пакетный установщик. Текущий
|
||||
рабочий каталог не важен:
|
||||
|
||||
```bash
|
||||
~/src/proxy-client/install.sh
|
||||
@@ -44,18 +24,54 @@ source ~/.bash_custom
|
||||
нельзя перемещать: домашние ссылки зависят от его постоянного пути.
|
||||
|
||||
По умолчанию установщик добавляет в `~/.bashrc` помеченный блок для
|
||||
`~/.local/bin` и Bash-модуля. Чтобы оставить настройки оболочки без изменений:
|
||||
`~/.local/bin` и Bash-модуля. После установки откройте новый Bash или примените
|
||||
блок в текущей сессии:
|
||||
|
||||
```bash
|
||||
source ~/.bashrc
|
||||
```
|
||||
|
||||
Чтобы оставить `~/.bashrc` без изменений, запустите:
|
||||
|
||||
```bash
|
||||
~/src/proxy-client/install.sh --no-shell-setup
|
||||
```
|
||||
|
||||
В этом случае подготовьте только текущую сессию вручную:
|
||||
|
||||
```bash
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
source ~/.config/proxy-client/shell.bash
|
||||
```
|
||||
|
||||
Для следующих сессий добавьте эти строки в подходящий Bash-конфиг сами.
|
||||
|
||||
Установщик не создаёт машинный `config` и закрытый `default.url`, не
|
||||
устанавливает Xray и не проверяет сеть. После установки примените изменения
|
||||
через `source ~/.bashrc`; с `--no-shell-setup` подключите модуль напрямую:
|
||||
`source ~/.config/proxy-client/shell.bash`. Затем выберите режим по разделу
|
||||
[«Настройка режима»](#настройка-режима). Без машинного конфига продолжает
|
||||
действовать режим Hiddify по умолчанию.
|
||||
устанавливает Xray и не проверяет сеть. После подключения команд выберите режим
|
||||
по разделу [«Настройка режима»](#настройка-режима). Без машинного конфига
|
||||
действует режим Hiddify по умолчанию.
|
||||
|
||||
### В составе dotfiles
|
||||
|
||||
Корневой установщик dotfiles подключает тот же пакет через Stow и загружает
|
||||
Bash-функции в новых интерактивных сессиях:
|
||||
|
||||
```bash
|
||||
cd ~/dotfiles
|
||||
./install.sh
|
||||
```
|
||||
|
||||
Он заранее создаёт `~/.local/bin` и `~/.config/proxy-client`, чтобы Stow
|
||||
размещал ссылки внутри них, а не превращал сами каталоги в ссылки на
|
||||
репозиторий. После установки откройте новый Bash или выполните:
|
||||
|
||||
```bash
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
source ~/.bash_custom
|
||||
```
|
||||
|
||||
Если `~/.local/bin` отсутствует в `PATH` и в новых сессиях, добавьте ту же строку
|
||||
`export` в свой Bash-конфиг: корневой установщик dotfiles его не изменяет.
|
||||
|
||||
## Как выбирается прокси
|
||||
|
||||
@@ -91,28 +107,46 @@ proxy-client status
|
||||
pclaude --version
|
||||
```
|
||||
|
||||
В WSL NAT mode IP Windows-шлюза меняется при перезапуске. Интерактивный
|
||||
`./install.sh` предлагает добавить обновление `hproxy.local` в `/etc/wsl.conf`.
|
||||
То же можно настроить вручную:
|
||||
#### WSL NAT mode
|
||||
|
||||
```ini
|
||||
[boot]
|
||||
command = "/path/to/dotfiles/scripts/setup-hproxy.sh"
|
||||
IP Windows-шлюза меняется при перезапуске WSL, поэтому `hproxy.local` нужно
|
||||
обновлять. В отдельно скопированном пакете системных помощников нет. Узнайте
|
||||
адрес шлюза:
|
||||
|
||||
```bash
|
||||
ip route show default | awk 'NR == 1 {print $3}'
|
||||
```
|
||||
|
||||
После изменения выполните `wsl --shutdown` из Windows. Обновить адрес без
|
||||
перезапуска WSL можно так:
|
||||
Затем откройте `/etc/hosts` через `sudoedit` и оставьте одну отдельную строку с
|
||||
полученным адресом:
|
||||
|
||||
```bash
|
||||
sudoedit /etc/hosts
|
||||
```
|
||||
|
||||
```text
|
||||
<адрес-шлюза> hproxy.local
|
||||
```
|
||||
|
||||
Не удаляйте другие имена на той же строке: при необходимости перенесите их на
|
||||
отдельную строку. Повторяйте обновление после перезапуска WSL.
|
||||
|
||||
С полным dotfiles запустите корневой `~/dotfiles/install.sh` интерактивно: он
|
||||
предложит автоматическое обновление при старте WSL. Обновить адрес сразу можно
|
||||
так:
|
||||
|
||||
```bash
|
||||
sudo ~/dotfiles/scripts/setup-hproxy.sh
|
||||
# или после загрузки Bash-функций:
|
||||
# после настройки автозапуска и загрузки общих Bash-функций:
|
||||
update_hproxy
|
||||
```
|
||||
|
||||
В NAT mode Hiddify должен слушать адрес, доступный через Windows-шлюз, а не
|
||||
только `127.0.0.1`.
|
||||
|
||||
В [WSL mirrored mode](https://learn.microsoft.com/windows/wsl/networking#mirrored-mode-networking)
|
||||
#### WSL mirrored mode
|
||||
|
||||
В [mirrored mode](https://learn.microsoft.com/windows/wsl/networking#mirrored-mode-networking)
|
||||
(`networkingMode=mirrored`) Windows-сервисы доступны из WSL через `127.0.0.1`.
|
||||
Чтобы сохранить адрес по умолчанию, добавьте алиас в Windows hosts:
|
||||
|
||||
@@ -121,9 +155,9 @@ update_hproxy
|
||||
127.0.0.1 hproxy.local
|
||||
```
|
||||
|
||||
Альтернатива — создать `config.external` с `address = 127.0.0.1`. В обоих
|
||||
случаях проверьте результат через `getent hosts hproxy.local` или
|
||||
`proxy-client status`.
|
||||
Альтернатива — настройте внешний режим по следующему разделу и укажите
|
||||
`address = 127.0.0.1`. Алиас проверяйте через `getent hosts hproxy.local`, а
|
||||
активный конфиг — через `proxy-client status`.
|
||||
|
||||
### Другой внешний прокси
|
||||
|
||||
@@ -169,7 +203,7 @@ chmod 600 ~/.config/proxy-client/default.url
|
||||
proxy-client install
|
||||
```
|
||||
|
||||
Запустите Xray в отдельной панели tmux:
|
||||
Запустите Xray в отдельном терминале или панели tmux:
|
||||
|
||||
```bash
|
||||
proxy-client start
|
||||
@@ -260,18 +294,30 @@ export PROXY_PREFLIGHT_TIMEOUT=5
|
||||
|
||||
### Ручное подключение без установщика
|
||||
|
||||
Если пакетный установщик запустить нельзя, создайте те же ссылки вручную:
|
||||
Если пакетный установщик запустить нельзя, выберите постоянный абсолютный путь
|
||||
к исходному каталогу и создайте те же ссылки вручную. Команды предполагают, что
|
||||
назначения ещё не заняты:
|
||||
|
||||
```bash
|
||||
mkdir -p ~/.local/bin ~/.config/proxy-client
|
||||
ln -s /path/to/proxy-client/.local/bin/proxy-client ~/.local/bin/proxy-client
|
||||
ln -s /path/to/proxy-client/.config/proxy-client/shell.bash \
|
||||
ln -s /absolute/path/to/proxy-client/.local/bin/proxy-client \
|
||||
~/.local/bin/proxy-client
|
||||
ln -s /absolute/path/to/proxy-client/.config/proxy-client/shell.bash \
|
||||
~/.config/proxy-client/shell.bash
|
||||
ln -s /path/to/proxy-client/.config/proxy-client/examples \
|
||||
ln -s /absolute/path/to/proxy-client/.config/proxy-client/examples \
|
||||
~/.config/proxy-client/examples
|
||||
chmod 755 /absolute/path/to/proxy-client/.local/bin/proxy-client
|
||||
```
|
||||
|
||||
Исполняемому файлу нужен режим `755`, а `~/.local/bin` должен входить в `PATH`.
|
||||
Подготовьте текущую Bash-сессию:
|
||||
|
||||
```bash
|
||||
export PATH="$HOME/.local/bin:$PATH"
|
||||
source ~/.config/proxy-client/shell.bash
|
||||
```
|
||||
|
||||
Для следующих сессий добавьте эти две строки в свой Bash-конфиг. Исходный
|
||||
каталог после этого нельзя перемещать: созданные ссылки зависят от его пути.
|
||||
|
||||
### Машинный конфиг
|
||||
|
||||
|
||||
Reference in new issue
Block a user