docs: update deploy examples
This commit is contained in:
3252a8
+48
-45
@@ -21,11 +21,35 @@ docker compose logs -f backend worker frontend
|
||||
- `worker` только после успешных миграций;
|
||||
- `frontend` как отдельный nginx-образ без Python runtime.
|
||||
|
||||
Для обратного прокси с Caddy используйте отдельный `deploy/compose/docker-compose-caddy.yml`.
|
||||
|
||||
Миграции не запускаются внутри backend. Их выполняет отдельный сервис `migrate`, поэтому старт
|
||||
приложения не создает гонки на схеме БД.
|
||||
|
||||
## Готовые папки запуска
|
||||
|
||||
Для production удобнее использовать не корневой compose, а отдельные примеры в
|
||||
[`deploy/examples`](../deploy/examples). В каждой папке лежат свой `docker-compose.yml`,
|
||||
`.env.example`, README и нужный конфиг рядом:
|
||||
|
||||
| Папка | Назначение | Запуск |
|
||||
| --- | --- | --- |
|
||||
| [`deploy/examples/caddy`](../deploy/examples/caddy) | Caddy с автоматическим HTTPS. | `cp .env.example .env`, заполнить `.env`, `docker compose up -d`. |
|
||||
| [`deploy/examples/nginx`](../deploy/examples/nginx) | Nginx в Docker-сети приложения, TLS-сертификаты кладутся в `ssl/`. | `cp .env.example .env`, заполнить `.env`, положить сертификаты, `docker compose up -d`. |
|
||||
| [`deploy/examples/newt`](../deploy/examples/newt) | Pangolin/Newt без входящих портов на сервере приложения. | `cp .env.example .env`, заполнить Newt credentials, создать ресурсы в Pangolin, `docker compose up -d`. |
|
||||
| [`deploy/examples/no-proxy`](../deploy/examples/no-proxy) | Прямая публикация портов backend/frontend. | `cp .env.example .env`, заполнить публичные URL и порты, `docker compose up -d`. |
|
||||
|
||||
Пример для Caddy:
|
||||
|
||||
```bash
|
||||
cd deploy/examples/caddy
|
||||
cp .env.example .env
|
||||
nano .env
|
||||
docker compose up -d
|
||||
docker compose logs -f caddy backend worker frontend
|
||||
```
|
||||
|
||||
Корневой `docker-compose.yml` оставлен для локальной сборки из исходников. Примеры в
|
||||
`deploy/examples` используют готовые GHCR-образы и не требуют указывать `-f`.
|
||||
|
||||
## Миграции
|
||||
|
||||
При обычном старте миграции применяются автоматически:
|
||||
@@ -57,8 +81,8 @@ docker compose logs migrate
|
||||
- `postgres`: PostgreSQL 17.
|
||||
- `redis`: Redis 7 для FSM, кеша, rate-limit, очередей и locks.
|
||||
|
||||
`deploy/compose/docker-compose-caddy.yml` добавляет `caddy` как внешний HTTP/HTTPS reverse proxy.
|
||||
Перед запуском замените example-домены прямо в `deploy/docker/caddy/Caddyfile`.
|
||||
В production-примерах внешний доступ добавляют `caddy`, `nginx`, `newt` или прямые `ports` в
|
||||
соответствующей папке из [`deploy/examples`](../deploy/examples).
|
||||
|
||||
## Логи и проверка
|
||||
|
||||
@@ -77,7 +101,8 @@ curl http://127.0.0.1:8080/health
|
||||
```
|
||||
|
||||
В обычном compose backend публикуется на `127.0.0.1:${WEB_SERVER_PORT:-8080}`, frontend на
|
||||
`127.0.0.1:${FRONTEND_PORT:-8082}`. В Caddy-варианте проверяйте `HTTP_BIND`.
|
||||
`127.0.0.1:${FRONTEND_PORT:-8082}`. В новых production-примерах проверяйте bind-переменные
|
||||
конкретной папки: `HTTP_BIND`, `HTTPS_BIND`, `WEB_SERVER_BIND` или `FRONTEND_BIND`.
|
||||
|
||||
## Обновление
|
||||
|
||||
@@ -192,68 +217,46 @@ docker compose up -d backend worker
|
||||
|
||||
## Обратный прокси
|
||||
|
||||
Вариант `deploy/compose/docker-compose-caddy.yml` проксирует:
|
||||
Готовые reverse-proxy примеры лежат в:
|
||||
|
||||
- webhook-домен целиком в `backend:8080`;
|
||||
- Mini App-домен целиком в `frontend:80`;
|
||||
- [`deploy/examples/caddy`](../deploy/examples/caddy) - Caddy, автоматический HTTPS;
|
||||
- [`deploy/examples/nginx`](../deploy/examples/nginx) - Nginx, сертификаты кладутся рядом в `ssl/`;
|
||||
- [`deploy/examples/newt`](../deploy/examples/newt) - Newt/Pangolin, без входящих портов на сервере приложения.
|
||||
|
||||
Во всех вариантах схема одинаковая:
|
||||
|
||||
- webhook/backend-домен целиком идет в `backend:8080`;
|
||||
- Mini App/frontend-домен целиком идет в `frontend:80`;
|
||||
- API/auth/theme routes Mini App дальше проксируются frontend nginx в `backend:8081`.
|
||||
|
||||
Встроенный `deploy/docker/caddy/Caddyfile` намеренно повторяет старую двухдоменную структуру:
|
||||
Минимальная логика Caddy:
|
||||
|
||||
```caddyfile
|
||||
# Replace the example domains with your real webhook and Mini App hostnames.
|
||||
app.example.com {
|
||||
encode zstd gzip
|
||||
|
||||
webhooks.example.com {
|
||||
reverse_proxy backend:8080
|
||||
}
|
||||
|
||||
web.example.com {
|
||||
encode zstd gzip
|
||||
|
||||
app.example.com {
|
||||
reverse_proxy frontend:80
|
||||
}
|
||||
```
|
||||
|
||||
Готовый пример для внешнего Nginx лежит в
|
||||
[`deploy/docker/nginx/remnawave-minishop.conf`](../deploy/docker/nginx/remnawave-minishop.conf).
|
||||
Он рассчитан на Nginx в той же Docker network, поэтому использует DNS-имена сервисов:
|
||||
|
||||
```nginx
|
||||
upstream remnawave_backend_webhooks {
|
||||
server backend:8080;
|
||||
}
|
||||
|
||||
upstream remnawave_frontend {
|
||||
server frontend:80;
|
||||
}
|
||||
```
|
||||
|
||||
Webhook и health-маршруты должны идти в `backend:8080`. Статические ассеты Mini App отдавайте через
|
||||
`frontend:80`; frontend nginx уже проксирует `/api/*`, `/auth/*` и ассеты тем/логотипов в
|
||||
`backend:8081`.
|
||||
Минимальная логика Nginx такая же: `webhooks.example.com` проксируется в `backend:8080`,
|
||||
`app.example.com` - в `frontend:80`. В `deploy/examples/nginx/nginx.conf.template` уже есть
|
||||
заголовки `X-Forwarded-*`, редирект HTTP -> HTTPS и пути сертификатов.
|
||||
|
||||
## Newt
|
||||
|
||||
Если `newt` запущен в одной Compose network с приложением, указывайте внутренние имена сервисов,
|
||||
а не порты на хосте.
|
||||
Для Newt используйте [`deploy/examples/newt`](../deploy/examples/newt). В compose уже есть сервис
|
||||
`newt`, а в `.env.example` - поля `PANGOLIN_ENDPOINT`, `NEWT_ID` и `NEWT_SECRET`.
|
||||
|
||||
Если используете Caddy-вариант и хотите публиковать стек одной точкой через Newt/Pangolin, укажите:
|
||||
|
||||
```text
|
||||
http://caddy:80
|
||||
```
|
||||
|
||||
Если публикуете через Newt/Pangolin без Caddy, настройте отдельные ресурсы:
|
||||
В Pangolin создайте два HTTP-ресурса для этого Newt site:
|
||||
|
||||
```text
|
||||
Mini App / frontend: http://frontend:80
|
||||
Webhooks / backend: http://backend:8080
|
||||
```
|
||||
|
||||
Такой вариант нормальный: Caddy не обязателен. Он нужен только если вы хотите заранее объединить
|
||||
frontend и backend-маршруты в один внутренний upstream.
|
||||
|
||||
`backend:8081` является внутренним WebApp API/auth-сервером для frontend nginx; обычно его не нужно
|
||||
указывать в Newt напрямую.
|
||||
|
||||
|
||||
@@ -4,17 +4,25 @@
|
||||
|
||||
Если вы используете только готовые Docker-образы и не собираете проект
|
||||
локально, git-команды из ручного способа не нужны. Достаточно обновить
|
||||
compose-файл до варианта с готовыми образами (`deploy/compose/docker-compose-remote-server.yml`)
|
||||
и перенести/обновить БД.
|
||||
compose-файл до одного из готовых примеров в `deploy/examples` и
|
||||
перенести/обновить БД. Самый прямой вариант без встроенного reverse proxy -
|
||||
`deploy/examples/no-proxy/docker-compose.yml`; для Caddy, Nginx и Newt есть
|
||||
такие же самостоятельные папки.
|
||||
|
||||
Минимальная последовательность:
|
||||
|
||||
```bash
|
||||
docker compose down
|
||||
|
||||
# Замените compose-файл на актуальный вариант для готовых образов.
|
||||
# Если файл лежит рядом, можно запускать его явно:
|
||||
IMAGE_TAG=3.4.0 docker compose -f deploy/compose/docker-compose-remote-server.yml up --no-start
|
||||
# Скопируйте старый .env в выбранную папку примера и обновите значения там.
|
||||
cp .env deploy/examples/no-proxy/.env
|
||||
nano deploy/examples/no-proxy/.env
|
||||
|
||||
# Подготовьте стек из готовых образов.
|
||||
IMAGE_TAG=3.4.0 docker compose \
|
||||
--env-file deploy/examples/no-proxy/.env \
|
||||
-f deploy/examples/no-proxy/docker-compose.yml \
|
||||
up --no-start
|
||||
|
||||
# Нужно только при переходе со старого имени volume remnawave-tg-shop-db-data.
|
||||
# Если у вас уже есть remnawave-minishop-db-data, этот шаг пропустите.
|
||||
@@ -23,8 +31,14 @@ docker run --rm \
|
||||
-v remnawave-minishop-db-data:/to \
|
||||
alpine sh -c "cd /from && cp -a . /to"
|
||||
|
||||
IMAGE_TAG=3.4.0 docker compose -f deploy/compose/docker-compose-remote-server.yml up -d
|
||||
docker compose -f deploy/compose/docker-compose-remote-server.yml logs migrate
|
||||
IMAGE_TAG=3.4.0 docker compose \
|
||||
--env-file deploy/examples/no-proxy/.env \
|
||||
-f deploy/examples/no-proxy/docker-compose.yml \
|
||||
up -d
|
||||
docker compose \
|
||||
--env-file deploy/examples/no-proxy/.env \
|
||||
-f deploy/examples/no-proxy/docker-compose.yml \
|
||||
logs migrate
|
||||
```
|
||||
|
||||
Сервис `migrate` сам применит недостающие схемные миграции к перенесённому
|
||||
@@ -61,7 +75,7 @@ docker compose -f deploy/compose/docker-compose-remote-server.yml logs migrate
|
||||
|
||||
- старые тома **не удаляются** автоматически — это безопасный бэкап на случай
|
||||
отката;
|
||||
- сертификаты Caddy (если используется `deploy/compose/docker-compose-caddy.yml`)
|
||||
- сертификаты Caddy (если используется `deploy/examples/caddy/docker-compose.yml`)
|
||||
тоже переносятся, чтобы Let's Encrypt не выписывал их заново и не упереться
|
||||
в rate limit;
|
||||
- схема БД обновляется автоматически: при первом `docker compose up -d` сервис
|
||||
@@ -89,7 +103,7 @@ docker compose -f deploy/compose/docker-compose-remote-server.yml logs migrate
|
||||
| `remnawave-minishop-db-data` | переименовать из `remnawave-tg-shop-db-data` | переносится скриптом | PostgreSQL |
|
||||
| `remnawave-minishop-redis-data` | — | создаётся пустым | Redis (FSM, rate-limit, cache, очередь webhooks, distributed locks) |
|
||||
| `remnawave-minishop-shop-data` | — | создаётся пустым | `/app/data`: `tariffs.json`, темы Web App, кэш логотипа/emoji |
|
||||
| `remnawave-minishop-caddy-data` / `…-caddy-config` | переименовать из `remnawave-tg-shop-caddy-*` | переносится скриптом | только при Caddy-варианте |
|
||||
| `remnawave-minishop-caddy-data` / `remnawave-minishop-caddy-config` | переименовать из `remnawave-tg-shop-caddy-*` | переносится скриптом | только при Caddy-варианте |
|
||||
|
||||
`redis-data` и `shop-data` стартуют пустыми — это нормально. Redis ничего
|
||||
долгоживущего не хранит (всё либо FSM, либо кеш с TTL), а `data/` инициализируется
|
||||
@@ -152,8 +166,10 @@ bash scripts/migrate_to_minishop.sh
|
||||
Примеры:
|
||||
|
||||
```bash
|
||||
# Caddy-вариант из raw
|
||||
COMPOSE_FILE=deploy/compose/docker-compose-caddy.yml \
|
||||
# Caddy-вариант из raw.
|
||||
# Перед запуском скопируйте старый .env в deploy/examples/caddy/.env
|
||||
# и заполните WEBHOOK_HOST / MINIAPP_HOST.
|
||||
COMPOSE_FILE=deploy/examples/caddy/docker-compose.yml \
|
||||
bash <(curl -fsSL https://raw.githubusercontent.com/3252a8/remnawave-minishop/main/scripts/migrate_to_minishop.sh)
|
||||
|
||||
# С переключением origin на форк 3252a8
|
||||
@@ -238,11 +254,18 @@ docker volume rm remnawave-tg-shop-caddy-data remnawave-tg-shop-caddy-config 2>/
|
||||
# Локальная сборка
|
||||
docker compose up --no-start --build
|
||||
|
||||
# Или Caddy-вариант
|
||||
docker compose -f deploy/compose/docker-compose-caddy.yml up --no-start
|
||||
# Или готовый Caddy-вариант из GHCR-образов
|
||||
cp .env deploy/examples/caddy/.env
|
||||
nano deploy/examples/caddy/.env
|
||||
docker compose \
|
||||
--env-file deploy/examples/caddy/.env \
|
||||
-f deploy/examples/caddy/docker-compose.yml \
|
||||
up --no-start
|
||||
|
||||
# Или готовый образ
|
||||
docker compose -f deploy/compose/docker-compose-remote-server.yml up --no-start
|
||||
# Другие готовые варианты:
|
||||
# deploy/examples/nginx/docker-compose.yml
|
||||
# deploy/examples/newt/docker-compose.yml
|
||||
# deploy/examples/no-proxy/docker-compose.yml
|
||||
```
|
||||
|
||||
5. **Перенесите том БД в новое имя:**
|
||||
@@ -275,9 +298,10 @@ docker volume rm remnawave-tg-shop-caddy-data remnawave-tg-shop-caddy-config 2>/
|
||||
```bash
|
||||
docker compose up -d
|
||||
# или
|
||||
docker compose -f deploy/compose/docker-compose-caddy.yml up -d
|
||||
# или
|
||||
docker compose -f deploy/compose/docker-compose-remote-server.yml up -d
|
||||
docker compose \
|
||||
--env-file deploy/examples/caddy/.env \
|
||||
-f deploy/examples/caddy/docker-compose.yml \
|
||||
up -d
|
||||
```
|
||||
|
||||
Сервис `migrate` запустится первым, обнаружит перенесённый том,
|
||||
@@ -332,11 +356,12 @@ server {
|
||||
}
|
||||
```
|
||||
|
||||
Полные примеры (Caddy, Newt/Pangolin) — в [docs/deployment.md](deployment.md)
|
||||
и [docs/webapp.md](webapp.md). Если раньше прокси указывал на
|
||||
Полные примеры (Caddy, Nginx, Newt/Pangolin и запуск без reverse proxy) — в
|
||||
[docs/deployment.md](deployment.md), [docs/webapp.md](webapp.md) и папке
|
||||
[`deploy/examples`](../deploy/examples). Если раньше прокси указывал на
|
||||
`remnawave-tg-shop:8000` напрямую, после миграции нужно либо переключиться на
|
||||
`backend:8080` / `frontend:80`, либо использовать встроенный Caddy-вариант,
|
||||
который уже знает правильную маршрутизацию.
|
||||
`backend:8080` / `frontend:80`, либо использовать готовый Caddy/Nginx/Newt
|
||||
пример, который уже знает правильную маршрутизацию.
|
||||
|
||||
## Если что-то пошло не так
|
||||
|
||||
|
||||
+13
-48
@@ -122,59 +122,24 @@ Email-вход работает через одноразовый код:
|
||||
|
||||
## Проксирование
|
||||
|
||||
Web App должен проксироваться отдельно от вебхуков:
|
||||
Рекомендуемая production-схема - два публичных домена:
|
||||
|
||||
```nginx
|
||||
upstream remnawave_frontend {
|
||||
server frontend:80;
|
||||
}
|
||||
- `WEBHOOK_BASE_URL`, например `https://webhooks.domain.com`, целиком проксируется в `backend:8080`;
|
||||
- `SUBSCRIPTION_MINI_APP_URL`, например `https://app.domain.com/`, целиком проксируется в `frontend:80`.
|
||||
|
||||
upstream remnawave_backend_webapp {
|
||||
server backend:8081;
|
||||
}
|
||||
`frontend` уже сам проксирует `/api/*`, `/auth/*`, `/webapp-logo` и ассеты тем/логотипов во внутренний
|
||||
WebApp API на `backend:8081`, поэтому внешний reverse proxy обычно не должен отправлять эти пути в
|
||||
`backend:8081` напрямую.
|
||||
|
||||
upstream remnawave_backend_webhooks {
|
||||
server backend:8080;
|
||||
}
|
||||
Готовые примеры лежат в [`deploy/examples`](../deploy/examples):
|
||||
|
||||
server {
|
||||
server_name app.domain.com;
|
||||
listen 443 ssl;
|
||||
http2 on;
|
||||
- `caddy` - Caddy с автоматическим HTTPS;
|
||||
- `nginx` - Nginx с сертификатами в соседней папке `ssl/`;
|
||||
- `newt` - Pangolin/Newt;
|
||||
- `no-proxy` - прямая публикация портов для проверки или внешней TLS-платформы.
|
||||
|
||||
ssl_certificate "/etc/nginx/ssl/app_fullchain.pem";
|
||||
ssl_certificate_key "/etc/nginx/ssl/app_privkey.key";
|
||||
|
||||
location / {
|
||||
proxy_pass http://remnawave_frontend;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
|
||||
location ~ ^/(api|auth)/ {
|
||||
proxy_pass http://remnawave_backend_webapp;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
|
||||
location /webhook/ {
|
||||
proxy_pass http://remnawave_backend_webhooks;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
В default `docker-compose.yml` наружу публикуются `frontend` и webhook/backend port, а внутри Docker network сервисы доступны друг другу по service DNS names:
|
||||
В default `docker-compose.yml` наружу публикуются `frontend` и webhook/backend port, а внутри Docker
|
||||
network сервисы доступны друг другу по service DNS names:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
|
||||
Reference in New Issue
Block a user