Merge pull request #675 from Fr1ngg/bedolaga/update-readme-for-install_bot.sh

docs: document installer usage
This commit is contained in:
Egor
2025-10-02 19:12:02 +03:00
committed by GitHub

View File

@@ -71,7 +71,48 @@ eGames Cookies | Cookies в формате key:value | Для панелей eGa
## 🚀 Быстрый старт
### 🐳 Docker запуск
### 🧙‍♂️ Автоустановка через `install_bot.sh`
Скрипт-установщик берёт на себя подготовку окружения, настройку конфигурации и дальнейшее обслуживание бота. Он работает поверх Docker Compose и требует заранее установить:
- **Docker Engine** и **Docker Compose plugin** (2.20+);
- **Git** и **Bash** (по умолчанию есть в большинстве Linux дистрибутивов);
- `openssl` (используется для генерации токенов, но не обязателен — при отсутствии скрипт использует `urandom`).
```bash
# 1. Скачай репозиторий
git clone https://github.com/Fr1ngg/remnawave-bedolaga-telegram-bot.git
cd remnawave-bedolaga-telegram-bot
# 2. Запусти мастер установки
chmod +x install_bot.sh # один раз, если файл не исполняемый
./install_bot.sh
```
На первом запуске мастер:
1. Спросит путь установки и сохранит его в `./.bot_install_state` — можно оставлять путь по умолчанию (текущая директория).
2. Поможет собрать `.env`: запросит обязательные токены (бот, Remnawave, админы), при необходимости сгенерирует Web API и PostgreSQL пароли, предложит авторизацию Basic Auth или eGames secret.
3. Подготовит структуру каталогов (`logs`, `data`, `backups` и т. д.) и проверит, что Docker готов к запуску.
4. Создаст (или обновит) `docker-compose.yml`, настроит внешнюю сеть `bot_network`, чтобы дальнейшие сервисы (например, Caddy) могли подключаться.
5. Запустит контейнеры бота, PostgreSQL и Redis и выведет их статус.
После установки повторный запуск `./install_bot.sh` открывает **интерактивное меню управления**:
- 📊 Мониторинг состояния контейнеров и ресурсов.
- ⚙️ Управление сервисами (запуск/остановка/пересборка).
- 📋 Просмотр и поиск по логам.
- 🔄 Обновление проекта из Git с автоматическим бэкапом.
- 💾 Создание и 📦 восстановление резервных копий (включая базу данных).
- 🧹 Очистка логов, бэкапов и образов.
- 🌐 Помощник настройки обратного прокси Caddy (webhook + miniapp, обновление `docker-compose`, перезагрузка).
- ⚙️ Конфигуратор `.env` (редактирование, пересоздание, маскировка секретов).
> 💡 Скрипт можно запускать сколько угодно раз — он хранит путь установки и понимает, когда конфигурация уже создана. Меню работает и по SSH (достаточно TTY), а для скриптов можно передать путь установки через stdin.
### 🐳 Ручной Docker запуск
Если не хочется пользоваться мастером, можно настроить всё вручную:
```bash
# 1. Скачай репозиторий
@@ -91,7 +132,7 @@ sudo chown -R 1000:1000 ./logs ./data
docker compose up -d
# 5. Проверь статус
docker compose logs
docker compose logs
```
---