diff --git a/README.md b/README.md index 33fc98f..2cc6af3 100644 --- a/README.md +++ b/README.md @@ -31,17 +31,21 @@
-## Что это такое +

🚀 Что это такое

-**OpenWrt Remote Hub** — это связка из VPS-панели и OpenWrt-агента, которая даёт удобный удалённый доступ к роутерам без проброса LuCI и SSH наружу. +OpenWrt Remote Hub — это связка из VPS-панели и OpenWrt-агента, которая даёт удобный удалённый доступ к роутерам без проброса LuCI и SSH наружу. + +

Роутер сам подключается к VPS изнутри сети, а ты заходишь в Hub-панель и открываешь нужный роутер, LuCI или SSH Web Terminal. +

+
-### Для чего +

🎯 Для чего

удалённо открыть LuCI зайти в SSH через браузер @@ -52,7 +56,7 @@
-### Из чего состоит +

🧩 Из чего состоит

VPS Hub-панель OpenWrt агент @@ -71,20 +75,20 @@ web terminal
-## Tech Stack +

🧰 Tech Stack

-### Router / Network / OpenWrt +

📡 Router / Network / OpenWrt

-

+

OpenWrt LuCI Dropbear CGI

-### VPS / Reverse / HTTPS +

🖥️ VPS / Reverse / HTTPS

-

+

Linux Python Shell @@ -96,18 +100,20 @@ web terminal --- -

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

+
-> После установки в конце появится вход: -> -> ```text -> login: admin -> password: admin -> ``` -> -> Пароль лучше поменять сразу после первого входа. +

⚡ Быстрый старт

-### VPS: поставить Hub, Xray, firewall и HTTPS одной командой +После установки в конце появится вход: + +```text +login: admin +password: admin +``` + +Пароль лучше поменять сразу после первого входа. + +

1️⃣ VPS: поставить Hub, Xray, firewall и HTTPS одной командой

```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/install-vps.sh?v=$(date +%s)" | sudo sh @@ -125,9 +131,9 @@ IP/домен VPS: hub.example.com ``` -Или просто нажать **Enter**, чтобы взять найденный IP сервера. +Или просто нажать Enter, чтобы взять найденный IP сервера. -### OpenWrt: поставить Remote Hub на роутер +

2️⃣ OpenWrt: поставить Remote Hub на роутер

```sh wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/install.sh?v=$(date +%s)" | sh @@ -140,9 +146,15 @@ owrt-remote doctor owrt-remote status ``` +
+ --- -

Схема работы

+
+ +

🛰️ Схема работы

+ +
```mermaid flowchart LR @@ -154,14 +166,18 @@ flowchart LR R --> S[SSH / Dropbear] ``` -**Главная идея:** роутер сам подключается к VPS изнутри сети. Наружу LuCI и SSH на роутере открывать не нужно. +
+ +Главная идея: роутер сам подключается к VPS изнутри сети. Наружу LuCI и SSH на роутере открывать не нужно. + +
--- -

Скриншоты интерфейса

-
+

🖼️ Скриншоты интерфейса

+
@@ -228,10 +244,10 @@ flowchart LR --- -

Видео-демо

-
+

🎬 Видео-демо

+ Видео-демо
Открытие Hub с телефона: статус роутера, LuCI и SSH Web Terminal. @@ -244,34 +260,78 @@ flowchart LR --- -| Возможность | Описание | -|:---:|:---:| -| **Router Cards** | Карточки роутеров в Hub-панели | -| **Online / Offline** | Быстрая проверка состояния роутеров | -| **LuCI через VPS** | Доступ к LuCI без прямого проброса портов | -| **SSH Web Terminal** | SSH в браузере, удобно даже с телефона | -| **Xray Reverse** | Роутер подключается к VPS сам | -| **HTTPS через nginx** | TLS-точка входа на `443/tcp` | -| **Firewall automation** | Скрипты помогают открыть нужные порты | -| **Doctor / Status** | Команды диагностики на OpenWrt | +
+ +

🎛️ Возможности

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ВозможностьОписание
🧭 Router CardsКарточки роутеров в Hub-панели
🟢 Online / OfflineБыстрая проверка состояния роутеров
🌐 LuCI через VPSДоступ к LuCI без прямого проброса портов
💻 SSH Web TerminalSSH в браузере, удобно даже с телефона
🔁 Xray ReverseРоутер подключается к VPS сам
🔐 HTTPS через nginxTLS-точка входа на 443/tcp
🧯 Firewall automationСкрипты помогают открыть нужные порты
🩺 Doctor / StatusКоманды диагностики на OpenWrt
--- -

Подробная установка

+
+ +

📦 Подробная установка

+ +
- Установка VPS подробно +🖥️ Установка VPS подробно + +
Если хочешь поставить повторно, но не сбрасывать текущий пароль: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/install-vps.sh?v=$(date +%s)" | sudo env RESET_LOGIN=0 sh ``` +
+ Если HTTPS не включился автоматически, HTTP-панель всё равно остаётся рабочей. После проверки firewall можно запустить: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/enable-https.sh?v=$(date +%s)" | sudo sh -s -- YOUR_VPS_IP ``` @@ -279,20 +339,32 @@ curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/
- HTTPS / SSL +🔐 HTTPS / SSL + +
Установщик пытается включить HTTPS сам. +

+ Схема такая: +
+ ```text Internet -> 443/nginx -> Hub -> Xray reverse -> OpenWrt ``` -Hub работает внутри на `80` и `8088`, а HTTPS на `443` принимает nginx и прокидывает запросы в Hub. +
+ +Hub работает внутри на 80 и 8088, а HTTPS на 443 принимает nginx и прокидывает запросы в Hub. + +

Для установки должны быть открыты порты: +
+ ```text 80/tcp - HTTP-панель и проверка Let's Encrypt 443/tcp - HTTPS-панель через nginx @@ -300,20 +372,32 @@ Hub работает внутри на `80` и `8088`, а HTTPS на `443` пр 8443/tcp - Xray / reverse endpoint ``` +
+ Включить HTTPS вручную на IP: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/enable-https.sh?v=$(date +%s)" | sudo sh -s -- YOUR_VPS_IP ``` +
+ Включить HTTPS вручную на домен: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/enable-https.sh?v=$(date +%s)" | sudo EMAIL="you@example.com" sh -s -- hub.example.com ``` +
+ Проверка на VPS: +
+ ```sh sudo ss -lntp | grep -E ':(80|443|8088)\b' curl -sS http://127.0.0.1:8088/health @@ -321,36 +405,56 @@ curl -k https://127.0.0.1/health sudo nginx -t ``` +
+ Нормальная картина: -- `443` слушает `nginx`; -- `80` и `8088` слушает `python3` Hub; -- certbot ставит auto-renew; -- скрипт добавляет hook для перезагрузки nginx после обновления сертификата. +

+ +443 слушает nginx
+80 и 8088 слушает python3 Hub
+certbot ставит auto-renew
+скрипт добавляет hook для перезагрузки nginx после обновления сертификата + +
- Уведомления и мини-лог VPS +🔔 Уведомления и мини-лог VPS -В панели Hub открой кнопку с логином, блок `Уведомления`, и нажми `Включить`. +
+ +В панели Hub открой кнопку с логином, блок Уведомления, и нажми Включить. + +

Что пишет Hub: -- вход в панель: устройство, браузер и IP; -- запуск Hub; -- запуск VPS после перезагрузки; -- короткую причину прошлого выключения/ребута по журналу VPS. +

+ +вход в панель: устройство, браузер и IP
+запуск Hub
+запуск VPS после перезагрузки
+короткую причину прошлого выключения/ребута по журналу VPS + +

Важно: если VPS полностью выключился или пропал интернет, сам VPS не сможет отправить уведомление в момент падения. Событие появится после следующего запуска, когда Hub снова поднимется. +
+
- Проверка после установки +✅ Проверка после установки + +
На VPS: +
+ ```sh sudo systemctl status owrt-remote --no-pager -l sudo systemctl status owrt-remote-xray --no-pager -l @@ -359,16 +463,24 @@ curl -sS http://127.0.0.1:8088/health curl -k https://127.0.0.1/health ``` +
+ Должно быть: -- `owrt-remote` active/running; -- `owrt-remote-xray` active/running; -- `*:80`, `*:443`, `*:8088`, `*:8443`; -- `127.0.0.1:18080` для LuCI первого роутера; -- `127.0.0.1:19080` для SSH первого роутера. +

+ +owrt-remote active/running
+owrt-remote-xray active/running
+*:80, *:443, *:8088, *:8443
+127.0.0.1:18080 для LuCI первого роутера
+127.0.0.1:19080 для SSH первого роутера + +

На OpenWrt: +
+ ```sh owrt-remote doctor owrt-remote status @@ -379,13 +491,21 @@ owrt-remote heartbeat --- -

Частые проблемы

+
+ +

🧯 Частые проблемы

+ +
- Панель VPS не открывается +❌ Панель VPS не открывается + +
Проверь сервисы и порты: +
+ ```sh sudo systemctl status owrt-remote --no-pager -l sudo journalctl -u owrt-remote -n 100 --no-pager @@ -393,10 +513,16 @@ sudo ss -lntp | grep -E ':(80|443|8088)\b' curl -sS http://127.0.0.1:8088/health ``` -Если на VPS `curl` отвечает `{"ok":true}`, но снаружи сайт не открывается, проблема почти всегда в firewall VPS-провайдера. +
+ +Если на VPS curl отвечает {"ok":true}, но снаружи сайт не открывается, проблема почти всегда в firewall VPS-провайдера. + +

Открой в личном кабинете VPS: +
+ ```text 80/tcp 443/tcp @@ -407,10 +533,14 @@ curl -sS http://127.0.0.1:8088/health
- Админка пишет proxy error: [Errno 111] Connection refused +🔌 Админка пишет proxy error: [Errno 111] Connection refused + +
Пересобери Xray config: +
+ ```sh sudo /opt/owrt-remote/owrt-remote-hub.py render-xray --out /etc/xray/owrt-remote.json sudo systemctl restart owrt-remote-xray @@ -420,36 +550,54 @@ sudo ss -lntp | grep -E ':(18080|18090|19080|19090)\b'
- SSH web-terminal просит пароль и молчит +⌨️ SSH web-terminal просит пароль и молчит + +
Проверь Dropbear на OpenWrt: +
+ ```sh /etc/init.d/dropbear status owrt-remote heartbeat ``` +
+ В телефоне используй поле снизу терминала: -- **Вставить** — вставить текст; -- **Enter** — отправить Enter; -- **Отправить** — отправить команду или пароль. +

+ +Вставить — вставить текст
+Enter — отправить Enter
+Отправить — отправить команду или пароль + +
- С мобильного интернета не открывается +📱 С мобильного интернета не открывается + +
Пробуй: +
+ ```text https://YOUR_VPS_IP/ http://YOUR_VPS_IP/ http://YOUR_VPS_IP:8088/ ``` +
+ Если по Wi-Fi работает, а через мобильный интернет нет, открой порты в firewall VPS-провайдера и проверь: +
+ ```sh sudo ss -lntp | grep -E ':(80|443|8088)' ``` @@ -458,33 +606,49 @@ sudo ss -lntp | grep -E ':(80|443|8088)' --- -

Удаление

+
+ +

🗑️ Удаление

+ +
- Удалить Hub с VPS полностью +🖥️ Удалить Hub с VPS полностью ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/uninstall-vps.sh?v=$(date +%s)" | sudo sh ``` +
+ Удалится: -- `owrt-remote`; -- `owrt-remote-xray`; -- `/opt/owrt-remote`; -- `/etc/xray/owrt-remote.json`; -- `/var/lib/owrt-remote`; -- nginx-конфиг HTTPS, certbot renewal hook и старые TLS override-файлы; -- правила `ufw` для `80/tcp`, `443/tcp`, `8088/tcp`, `8443/tcp`. +

+ +owrt-remote
+owrt-remote-xray
+/opt/owrt-remote
+/etc/xray/owrt-remote.json
+/var/lib/owrt-remote
+nginx-конфиг HTTPS, certbot renewal hook и старые TLS override-файлы
+правила ufw для 80/tcp, 443/tcp, 8088/tcp, 8443/tcp + +

Удалить Hub, но оставить базу роутеров: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/uninstall-vps.sh?v=$(date +%s)" | sudo env PURGE=0 sh ``` +
+ Удалить дополнительно сам Xray binary: +
+ ```sh curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/vps/uninstall-vps.sh?v=$(date +%s)" | sudo env REMOVE_XRAY=1 sh ``` @@ -492,25 +656,33 @@ curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/
- Удалить агент с OpenWrt полностью +📡 Удалить агент с OpenWrt полностью ```sh wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/uninstall.sh?v=$(date +%s)" | PURGE=1 sh ``` +
+ Удалится: -- `/usr/sbin/owrt-remote`; -- `/etc/init.d/owrt-remote`; -- `/www/cgi-bin/owrt-remote`; -- пункт меню LuCI; -- rpcd ACL; -- `/etc/config/owrtremote`; -- `/etc/owrt-remote/web.key`; -- `/etc/xray/owrt-remote-client.json`. +

+ +/usr/sbin/owrt-remote
+/etc/init.d/owrt-remote
+/www/cgi-bin/owrt-remote
+пункт меню LuCI
+rpcd ACL
+/etc/config/owrtremote
+/etc/owrt-remote/web.key
+/etc/xray/owrt-remote-client.json + +

Удалить только файлы панели, но оставить конфиг: +
+ ```sh wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/uninstall.sh?v=$(date +%s)" | sh ``` @@ -519,10 +691,14 @@ wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/m --- -

Дерево проекта

+
+ +

🌳 Дерево проекта

+ +
-Открыть дерево файлов +Открыть дерево файлов ```text . @@ -558,33 +734,68 @@ wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/m --- -

Мини-шпаргалка команд

-
-| Где | Команда | Что делает | -|:---:|:---:|:---:| -| VPS | `systemctl status owrt-remote` | статус Hub | -| VPS | `systemctl status owrt-remote-xray` | статус Xray reverse | -| VPS | `curl -sS http://127.0.0.1:8088/health` | healthcheck Hub | -| VPS | `sudo nginx -t` | проверка nginx-конфига | -| OpenWrt | `owrt-remote doctor` | диагностика агента | -| OpenWrt | `owrt-remote status` | текущий статус | -| OpenWrt | `owrt-remote heartbeat` | отправить heartbeat | +

🧾 Мини-шпаргалка команд

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ГдеКомандаЧто делает
VPSsystemctl status owrt-remoteстатус Hub
VPSsystemctl status owrt-remote-xrayстатус Xray reverse
VPScurl -sS http://127.0.0.1:8088/healthhealthcheck Hub
VPSsudo nginx -tпроверка nginx-конфига
OpenWrtowrt-remote doctorдиагностика агента
OpenWrtowrt-remote statusтекущий статус
OpenWrtowrt-remote heartbeatотправить heartbeat
--- -

Лицензия

-
-Этот проект распространяется под лицензией **MIT**. +

Лицензия

+ +Этот проект распространяется под лицензией MIT. + +

Можно использовать, копировать, изменять, публиковать и распространять проект при сохранении текста лицензии. -
+

MIT License @@ -602,6 +813,8 @@ wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/m OpenWrt Remote Hub — свой VPS, свой доступ, свои роутеры под контролем. +

+ Footer