docs: refactor docs structure
This commit is contained in:
@@ -1,10 +1,10 @@
|
||||
# Обзор
|
||||
|
||||
Remnawave Minishop состоит из Telegram-бота, backend API, worker-процессов, frontend/Mini App и инфраструктурных сервисов PostgreSQL и Redis. В production эти части запускаются через Docker Compose и общаются с Remnawave Panel по API и вебхукам.
|
||||
Remnawave Minishop состоит из Telegram-бота, backend API, worker-процессов, frontend/Mini App и инфраструктурных сервисов PostgreSQL и Redis. В продакшене эти части запускаются через Docker Compose и общаются с Remnawave Panel по API и вебхукам.
|
||||
|
||||
## Основные компоненты
|
||||
|
||||
- **Backend** - Telegram webhook, платежные вебхуки, panel webhooks, API для Mini App и админки.
|
||||
- **Backend** - вебхук Telegram, платежные вебхуки, вебхуки панели, API для Mini App и админки.
|
||||
- **Worker** - фоновые задачи, синхронизация подписок, обработка очереди вебхуков и тарифных событий.
|
||||
- **Frontend** - отдельный nginx-образ с Mini App и админкой.
|
||||
- **PostgreSQL** - пользователи, платежи, настройки, поддержка, промокоды и служебные данные.
|
||||
@@ -21,6 +21,6 @@ Remnawave Minishop состоит из Telegram-бота, backend API, worker-п
|
||||
## Куда идти дальше
|
||||
|
||||
- [Установка](setup.md) - базовый запуск через Compose.
|
||||
- [Deploy examples](../deploy-examples/index.md) - готовые варианты публикации.
|
||||
- [Развертывание](../deployment.md) - Docker Compose, Caddy, Nginx, Pangolin/Newt и запуск без обратного прокси.
|
||||
- [Архитектура](../architecture.md) - структура каталогов и сервисов.
|
||||
- [Mini App](../features/web-app.md) - публичный frontend, Telegram OAuth и инструкции установки.
|
||||
|
||||
@@ -15,17 +15,27 @@ docker compose logs -f backend worker frontend
|
||||
## Что заполнить в первую очередь
|
||||
|
||||
- `BOT_TOKEN` и `ADMIN_IDS` для доступа к боту и админке.
|
||||
- `WEBHOOK_BASE_URL` для Telegram, платежных и panel webhook URL.
|
||||
- `WEBHOOK_BASE_URL` для Telegram, платежных вебхуков и вебхуков панели.
|
||||
- `SUBSCRIPTION_MINI_APP_URL` для Mini App и кнопок в Telegram.
|
||||
- `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_DB`.
|
||||
- `WEBAPP_SESSION_SECRET`, `WEBHOOK_SECRET_TOKEN`, `PANEL_API_URL`, `PANEL_API_KEY`, `PANEL_WEBHOOK_SECRET`.
|
||||
|
||||
## Как выбрать Compose-вариант
|
||||
|
||||
- Для быстрого публичного HTTPS берите [Caddy](../deploy-examples/caddy.md).
|
||||
- Если у вас уже есть TLS-сертификаты и нужен Nginx в Docker-сети, берите [Nginx](../deploy-examples/nginx.md).
|
||||
- Если нельзя открывать входящие порты на сервере приложения, берите [Pangolin/Newt](../deploy-examples/newt.md).
|
||||
- Для локальной проверки или внешнего TLS-терминатора берите [no-proxy](../deploy-examples/no-proxy.md).
|
||||
Для продакшена по умолчанию берите [Caddy](../deployment.md#caddy-рекомендуемый-вариант): это самый короткий путь к публичному HTTPS без ручной раскладки сертификатов.
|
||||
|
||||
```bash
|
||||
cd deploy/examples/caddy
|
||||
cp .env.example .env
|
||||
nano .env
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
Остальные варианты описаны в [разделе развертывания](../deployment.md#готовые-папки-запуска):
|
||||
|
||||
- [Nginx](../deployment.md#nginx) - если у вас уже есть TLS-сертификаты и нужен Nginx в Docker-сети;
|
||||
- [Pangolin/Newt](../deployment.md#pangolin--newt) - если нельзя открывать входящие порты на сервере приложения;
|
||||
- [без обратного прокси](../deployment.md#без-обратного-прокси) - для локальной проверки или внешнего TLS-терминатора.
|
||||
|
||||
## После первого входа
|
||||
|
||||
|
||||
Reference in New Issue
Block a user