From f6949705568378401bc007e9c9acb05bfca86f69 Mon Sep 17 00:00:00 2001
From: kzolotarev95 <158571179+kzolotarev95@users.noreply.github.com>
Date: Thu, 2 Jul 2026 07:40:39 +0400
Subject: [PATCH] Update README.md
---
README.md | 267 ++++++++++++++++++++++++++++++++++++++++++------------
1 file changed, 209 insertions(+), 58 deletions(-)
diff --git a/README.md b/README.md
index 9a740b4..f009551 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,104 @@
-## Быстрый старт
+---
-### VPS: поставить Hub, Xray, firewall и HTTPS через nginx одной командой
+## ✨ Что это такое
+
+**OpenWrt Remote Hub** — это связка из VPS-панели и OpenWrt-агента, которая даёт удобный удалённый доступ к роутерам без проброса LuCI и SSH наружу.
+
+Роутер сам подключается к VPS изнутри сети, а ты заходишь в красивую Hub-панель и открываешь нужный роутер, LuCI или SSH Web Terminal.
+
+
+
+|
+
+### 🚀 Для чего
+
+- удалённо открыть LuCI;
+- зайти в SSH через браузер;
+- видеть Online/Offline роутеров;
+- держать всё за HTTPS;
+- не светить домашнюю сеть наружу.
+
+ |
+
+
+### 🧩 Из чего состоит
+
+- VPS Hub-панель;
+- OpenWrt агент;
+- Xray reverse-туннели;
+- nginx HTTPS proxy;
+- firewall automation;
+- web terminal.
+
+ |
+
+
+
+---
+
+## 🧱 Tech Stack
+
+### Router / Network / OpenWrt
+
+
+
+
+
+
+
+
+### VPS / Reverse / 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
@@ -47,16 +110,15 @@ curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/
IP/домен VPS:
```
-Можно вставить домен, например `hub.example.com`, или нажать Enter, чтобы взять найденный IP сервера.
-
-После установки в конце будет вход:
+Можно вставить домен, например:
```text
-login: admin
-password: admin
+hub.example.com
```
-### OpenWrt: поставить Remote Hub на роутер
+Или просто нажать **Enter**, чтобы взять найденный IP сервера.
+
+### 2️⃣ OpenWrt: поставить Remote Hub на роутер
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/main/install.sh?v=$(date +%s)" | sh
@@ -69,18 +131,49 @@ owrt-remote doctor
owrt-remote status
```
-## Схема
+---
-
+## 🛰️ Схема работы
+
-Роутер сам подключается к VPS изнутри сети. Наружу LuCI и SSH на роутере открывать не нужно.
+

+
-## Раскрыть разделы
+```mermaid
+flowchart LR
+ U[User Browser] -->|HTTPS 443| N[nginx on VPS]
+ N --> H[OpenWrt Remote Hub]
+ H --> X[Xray Reverse]
+ X --> R[OpenWrt Router]
+ R --> L[LuCI]
+ R --> S[SSH / Dropbear]
+```
+
+**Главная идея:** роутер сам подключается к VPS изнутри сети. Наружу LuCI и SSH на роутере открывать не нужно.
+
+---
+
+## 🎛️ Возможности
+
+| Возможность | Описание |
+|---|---|
+| 🧭 **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 |
+
+---
+
+## 📦 Подробная установка
-Установка VPS подробно
+🖥️ Установка VPS подробно
Если хочешь поставить повторно, но не сбрасывать текущий пароль:
@@ -88,7 +181,7 @@ owrt-remote status
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 можно запустить:
+Если 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
@@ -97,16 +190,25 @@ curl -fsSL "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/
-HTTPS / SSL
+🔐 HTTPS / SSL
-Установщик пытается включить HTTPS сам. Схема такая: Hub работает внутри на `80` и `8088`, а HTTPS на `443` принимает nginx и прокидывает запросы в Hub.
+Установщик пытается включить HTTPS сам.
+
+Схема такая:
+
+```text
+Internet -> 443/nginx -> Hub -> Xray reverse -> OpenWrt
+```
+
+Hub работает внутри на `80` и `8088`, а HTTPS на `443` принимает nginx и прокидывает запросы в Hub.
Для установки должны быть открыты порты:
```text
-80/tcp - HTTP-панель и проверка Let's Encrypt
-443/tcp - HTTPS-панель через nginx
-8088/tcp - прямой HTTP-порт Hub, можно закрыть позже в firewall провайдера
+80/tcp - HTTP-панель и проверка Let's Encrypt
+443/tcp - HTTPS-панель через nginx
+8088/tcp - прямой HTTP-порт Hub, можно закрыть позже в firewall провайдера
+8443/tcp - Xray / reverse endpoint
```
Включить HTTPS вручную на IP:
@@ -130,13 +232,17 @@ 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:
@@ -166,10 +272,14 @@ owrt-remote heartbeat
-
-Частые проблемы
+---
-### Панель VPS не открывается
+## 🧯 Частые проблемы
+
+
+❌ Панель VPS не открывается
+
+Проверь сервисы и порты:
```sh
sudo systemctl status owrt-remote --no-pager -l
@@ -189,7 +299,10 @@ curl -sS http://127.0.0.1:8088/health
8443/tcp
```
-### Админка пишет `proxy error: [Errno 111] Connection refused`
+
+
+
+🔌 Админка пишет proxy error: [Errno 111] Connection refused
Пересобери Xray config:
@@ -199,7 +312,10 @@ sudo systemctl restart owrt-remote-xray
sudo ss -lntp | grep -E ':(18080|18090|19080|19090)\b'
```
-### SSH web-terminal просит пароль и молчит
+
+
+
+⌨️ SSH web-terminal просит пароль и молчит
Проверь Dropbear на OpenWrt:
@@ -210,11 +326,14 @@ owrt-remote heartbeat
В телефоне используй поле снизу терминала:
-- `Вставить` - вставить текст;
-- `Enter` - отправить Enter;
-- `Отправить` - отправить команду или пароль.
+- **Вставить** — вставить текст;
+- **Enter** — отправить Enter;
+- **Отправить** — отправить команду или пароль.
-### С мобильного интернета не открывается
+
+
+
+📱 С мобильного интернета не открывается
Пробуй:
@@ -224,7 +343,7 @@ http://YOUR_VPS_IP/
http://YOUR_VPS_IP:8088/
```
-Если по Wi-Fi работает, а через мобильный интернет нет, открой порты в firewall VPS-провайдера и проверь:
+Если по Wi‑Fi работает, а через мобильный интернет нет, открой порты в firewall VPS-провайдера и проверь:
```sh
sudo ss -lntp | grep -E ':(80|443|8088)'
@@ -232,10 +351,12 @@ 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
@@ -266,7 +387,7 @@ 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
@@ -291,9 +412,11 @@ wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-remote/m
-## Дерево проекта
+---
-
+## 🌳 Дерево проекта
+
+
Открыть дерево файлов
```text
@@ -327,3 +450,31 @@ 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 |
+
+---
+
+
+
+

+
+
+
+
OpenWrt Remote Hub — свой VPS, свой доступ, свои роутеры под контролем.
+
+

+
+