Polish GitHub README presentation

This commit is contained in:
kzolotarev95 committed 2026-06-28 22:39:57 +04:00
1 parent d049e272ec
commit 27edacf05c
1 file changed
+165 -134
+165 -134
View File
@@ -1,23 +1,24 @@
# luci-app-owrt-full-backup
<div align="center">
![OpenWrt](https://img.shields.io/badge/OpenWrt-22--25-00A3E0?style=for-the-badge)
![LuCI](https://img.shields.io/badge/LuCI-web%20panel-16A34A?style=for-the-badge)
![Install](https://img.shields.io/badge/install-without%20ipk-111827?style=for-the-badge)
# OpenWrt Full Backup
Веб-панель и CLI-утилита для полного бэкапа OpenWrt. Сборка `.ipk` не нужна: модуль ставится прямо с GitHub на роутер.
**LuCI web-панель и SSH-утилита для полного бэкапа OpenWrt без сборки `.ipk`.**
## Что умеет
[![OpenWrt](https://img.shields.io/badge/OpenWrt-22.x%20%7C%2023.x%20%7C%2024.x%20%7C%2025.x-00A3E0?style=for-the-badge)](https://openwrt.org/)
[![LuCI](https://img.shields.io/badge/LuCI-web%20panel-16A34A?style=for-the-badge)](https://openwrt.org/docs/guide-user/luci/start)
[![No Lua runtime](https://img.shields.io/badge/LuCI-no%20Lua%20runtime-111827?style=for-the-badge)](#если-в-luci-ошибка-no-lua-runtime-installed)
[![Install](https://img.shields.io/badge/install-one%20command-2563EB?style=for-the-badge)](#быстрая-установка)
- Создает архив бэкапа через веб-панель LuCI или через SSH.
- Сохраняет настройки OpenWrt через `sysupgrade -b`.
- Сохраняет список установленных пакетов `opkg`.
- Может добавить снимок `/overlay/upper`.
- Может добавить снимок `/rom`.
- Может добавить firmware image, если файл прошивки уже лежит на роутере.
- Может добавить raw MTD dump для полного дампа flash-разделов.
- Показывает состояние памяти и температуру роутера.
- Позволяет скачать, загрузить, посмотреть и удалить архив из веб-панели.
- Позволяет восстановить настройки, пакеты, overlay или firmware image отдельными галочками.
[Telegram](https://t.me/kzolotarev95) · [GitHub автора](https://github.com/kzolotarev95)
</div>
## Зачем нужен модуль
`luci-app-owrt-full-backup` делает удобную панель в OpenWrt для создания, скачивания, загрузки и восстановления архивов бэкапа. Подходит для обычного сохранения настроек, переноса конфигурации после перепрошивки и подготовки полного архива роутера перед экспериментами.
> [!IMPORTANT]
> После установки скрипт покажет приватную ссылку с `key=...`. Не отдавай ее посторонним: по этой ссылке можно создавать и восстанавливать бэкапы.
## Быстрая установка
@@ -27,29 +28,93 @@
wget -O - https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh | sh
```
После установки скрипт покажет приватную ссылку:
После установки открой:
```text
Открыть: http://192.168.1.1/cgi-bin/owrt-full-backup?key=SECRET
LuCI -> Службы -> OpenWrt Full Backup
```
Эту ссылку держи в секрете: ключ в URL дает доступ к созданию и восстановлению бэкапов.
Пункт в LuCI:
Также установщик покажет прямую ссылку:
```text
Службы -> OpenWrt Full Backup
http://192.168.1.1/cgi-bin/owrt-full-backup?key=SECRET
```
## Обновление
## Что умеет
Если нужно принудительно поставить свежую версию с GitHub:
| Возможность | Что делает |
| --- | --- |
| Веб-панель LuCI | Пункт `Службы -> OpenWrt Full Backup` и отдельная защищенная CGI-панель |
| Бэкап настроек | Создает стандартный `sysupgrade` backup конфигурации OpenWrt |
| Список пакетов | Сохраняет список установленных пакетов `opkg` |
| Overlay snapshot | Может добавить `/overlay/upper` |
| ROM snapshot | Может добавить снимок `/rom` |
| Firmware image | Может положить в архив готовый `sysupgrade.bin` |
| Raw MTD dump | Может сохранить `/dev/mtd*`, если архив пишется на USB/диск |
| Архивы в веб-панели | Скачать, загрузить, посмотреть и удалить архив |
| Восстановление | Отдельные галочки для настроек, пакетов, overlay и firmware |
| Виджеты роутера | Показывает разделы памяти, свободное место и температуру |
## Как выглядит сценарий работы
1. Открываешь `Службы -> OpenWrt Full Backup`.
2. Выбираешь папку для архива, лучше USB или диск: `/mnt/usb`.
3. Нажимаешь `Создать бэкап`.
4. На странице виден журнал выполнения и таймер.
5. После завершения архив появляется в списке.
6. Архив можно скачать, удалить, загрузить обратно или восстановить.
## Безопасное место для архива
`/tmp` в OpenWrt обычно находится в RAM. Для маленького бэкапа настроек этого может хватить, но для больших архивов лучше сразу использовать USB/диск.
Рекомендуемый путь:
```text
/mnt/usb
```
> [!WARNING]
> Raw MTD dump может быть очень большим и привязан к конкретной модели роутера. Модуль не дает сохранять raw MTD в `/tmp`, чтобы не забить RAM и не получить `No space left on device`.
## CLI-команды
Создать бэкап на USB:
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh?v=$(date +%s)" | sh
owrt-full-backup create -o /mnt/usb
```
Скрипт сам обновляет файлы, чистит кэш LuCI и перезапускает нужные службы.
Добавить firmware image:
```sh
owrt-full-backup create -o /mnt/usb --firmware-image /tmp/openwrt-sysupgrade.bin
```
Посмотреть архив:
```sh
owrt-full-backup inspect /mnt/usb/router-owrt-full-backup.tar.gz
```
Восстановить только настройки:
```sh
owrt-full-backup restore /mnt/usb/router-owrt-full-backup.tar.gz --yes --no-packages
```
## Что ставится на роутер
| Путь | Назначение |
| --- | --- |
| `/usr/sbin/owrt-full-backup` | Основная CLI-команда |
| `/usr/sbin/owrt-full-backup-upload` | Потоковая загрузка `.tar.gz` из браузера без Lua |
| `/www/cgi-bin/owrt-full-backup` | Основная веб-панель |
| `/www/luci-static/resources/view/owrt_full_backup.js` | LuCI-страница-редирект без Lua runtime |
| `/usr/share/luci/menu.d/luci-app-owrt-full-backup.json` | Пункт меню LuCI |
| `/usr/share/rpcd/acl.d/luci-app-owrt-full-backup.json` | ACL-доступ LuCI к приватному ключу |
| `/etc/config/fullbackup` | Настройки по умолчанию |
| `/etc/owrt-full-backup/web.key` | Приватный ключ веб-панели |
## Структура проекта
@@ -83,123 +148,19 @@ wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-bac
└── owrt_full_backup.js
```
## Что ставится на роутер
## Обновление
| Путь | Назначение |
| --- | --- |
| `/usr/sbin/owrt-full-backup` | CLI-команда для создания, просмотра и восстановления архива |
| `/usr/sbin/owrt-full-backup-upload` | Потоковая загрузка `.tar.gz` из браузера без Lua |
| `/www/cgi-bin/owrt-full-backup` | Веб-панель |
| `/www/luci-static/resources/view/owrt_full_backup.js` | LuCI-страница-редирект без Lua runtime |
| `/usr/share/luci/menu.d/luci-app-owrt-full-backup.json` | Пункт меню LuCI для OpenWrt 22-25 |
| `/usr/share/rpcd/acl.d/luci-app-owrt-full-backup.json` | Доступ LuCI к приватному веб-ключу |
| `/etc/config/fullbackup` | Настройки по умолчанию |
| `/etc/owrt-full-backup/web.key` | Приватный ключ веб-панели |
## Как делать бэкап
Через веб-панель:
1. Открой `Службы -> OpenWrt Full Backup`.
2. Выбери папку для архива.
3. Нажми `Создать бэкап`.
4. Следи за журналом выполнения на странице.
5. После завершения архив появится в списке ниже.
Через SSH:
```sh
owrt-full-backup create -o /mnt/usb
```
Если нужен firmware image:
```sh
owrt-full-backup create -o /mnt/usb --firmware-image /tmp/openwrt-sysupgrade.bin
```
## Важное про `/tmp`, USB и raw MTD
`/tmp` в OpenWrt обычно находится в RAM. Для маленького бэкапа настроек этого хватает, но для ROM snapshot, firmware image или raw MTD dump лучше сразу использовать флешку или диск:
```text
/mnt/usb
```
Raw MTD dump может быть очень большим и привязан к конкретной модели, разметке flash и загрузчику. Не сохраняй raw MTD в `/tmp`: модуль теперь сразу остановит такую попытку понятной ошибкой.
## Восстановление
Посмотреть архив:
```sh
owrt-full-backup inspect /mnt/usb/router-owrt-full-backup.tar.gz
```
Восстановить только настройки:
```sh
owrt-full-backup restore /mnt/usb/router-owrt-full-backup.tar.gz --yes --no-packages
```
В веб-панели восстановление запускается только после ввода `RESTORE`. Это защита от случайного клика.
## Если пункт не появился в LuCI
Сначала обнови модуль свежей командой:
Принудительно поставить свежую версию с GitHub:
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh?v=$(date +%s)" | sh
```
Если в меню все еще не видно:
```sh
rm -rf /tmp/luci-indexcache /tmp/luci-modulecache /tmp/luci-indexcache.* /tmp/luci-modulecache.*
/etc/init.d/rpcd restart
/etc/init.d/uhttpd restart
```
Потом обнови страницу LuCI или выйди из LuCI и зайди снова. Прямая приватная ссылка из вывода `install.sh` тоже всегда работает.
## Если в LuCI ошибка `No Lua runtime installed`
Поставь свежую версию. Модуль больше не использует Lua-controller для пункта меню LuCI:
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh?v=$(date +%s)" | sh
```
Установщик удалит старый файл:
```text
/usr/lib/lua/luci/controller/owrt_full_backup.lua
```
И заменит его на LuCI JS-view + rpcd ACL.
## Если ошибка `No space left on device`
Причина почти всегда одна: архив создается в `/tmp`, а там RAM закончилась.
Что сделать:
```sh
mkdir -p /mnt/usb
owrt-full-backup create -o /mnt/usb
```
В веб-панели укажи папку `/mnt/usb`. Для raw MTD dump это обязательно.
## Если при загрузке архива браузер пишет `ERR_CONNECTION_RESET`
Обнови модуль. Загрузка архива теперь идет потоково: файл пишется сразу на диск, а не целиком в память.
Если ошибка осталась, проверь свободное место в папке для архивов и ставь папку на USB/диск, например `/mnt/usb`.
Скрипт обновляет файлы, удаляет старый Lua-controller, чистит кэш LuCI и перезапускает `rpcd/uhttpd`.
## Удаление
Удалить модуль, но оставить конфиг и ключ:
Удалить модуль, но оставить конфиг и веб-ключ:
```sh
wget -O - https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/uninstall.sh | sh
@@ -212,3 +173,73 @@ wget -O - https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-back
```
Архивы бэкапов при удалении не стираются.
## Диагностика
<details>
<summary>Пункт не появился в LuCI</summary>
Обнови модуль и перезапусти кэш LuCI:
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh?v=$(date +%s)" | sh
rm -rf /tmp/luci-indexcache /tmp/luci-modulecache /tmp/luci-indexcache.* /tmp/luci-modulecache.*
/etc/init.d/rpcd restart
/etc/init.d/uhttpd restart
```
Потом обнови страницу LuCI или выйди и зайди снова.
</details>
<details>
<summary>В LuCI ошибка `No Lua runtime installed`</summary>
Поставь свежую версию. Модуль больше не использует Lua-controller для пункта меню LuCI.
```sh
wget -O - "https://raw.githubusercontent.com/kzolotarev95/luci-app-owrt-full-backup/main/install.sh?v=$(date +%s)" | sh
```
Проверка:
```sh
test ! -e /usr/lib/lua/luci/controller/owrt_full_backup.lua && echo "Lua controller удален"
```
</details>
<details>
<summary>Ошибка `No space left on device`</summary>
Архив создается в `/tmp`, а там закончилась RAM. Используй USB/диск:
```sh
mkdir -p /mnt/usb
owrt-full-backup create -o /mnt/usb
```
В веб-панели тоже укажи `/mnt/usb`.
</details>
<details>
<summary>Браузер пишет `ERR_CONNECTION_RESET` при загрузке архива</summary>
Обнови модуль. Загрузка архива идет потоково и не держит весь `.tar.gz` в памяти.
Если ошибка осталась, проверь свободное место в папке архива и используй USB/диск:
```text
/mnt/usb
```
</details>
## Автор
Проект: `luci-app-owrt-full-backup`
Автор: [byzks95 / kzolotarev95](https://github.com/kzolotarev95)
Связь: [Telegram](https://t.me/kzolotarev95)