docs: update docs
This commit is contained in:
@@ -0,0 +1,176 @@
|
||||
# Развертывание
|
||||
|
||||
Документ описывает запуск через Docker Compose, маршруты вебхуков и варианты reverse proxy. Перед запуском заполните `.env` по [configuration.md](configuration.md).
|
||||
|
||||
## Docker Compose
|
||||
|
||||
Локальная сборка:
|
||||
|
||||
```bash
|
||||
docker compose up -d --build
|
||||
docker compose logs -f remnawave-minishop
|
||||
```
|
||||
|
||||
Запуск из готового образа:
|
||||
|
||||
```bash
|
||||
IMAGE_TAG=3.1.0 docker compose -f docker-compose-remote-server.yml up -d
|
||||
```
|
||||
|
||||
`docker-compose-remote-server.yml` можно использовать как шаблон и заменить `image:` на нужный образ. По умолчанию используется `ghcr.io/3252a8/remnawave-minishop:latest`.
|
||||
|
||||
## Порты
|
||||
|
||||
| Порт | Назначение |
|
||||
| --- | --- |
|
||||
| `WEB_SERVER_PORT` (`8080`) | Telegram webhook, платежные вебхуки, Remnawave webhook. |
|
||||
| `WEBAPP_SERVER_PORT` (`8081`) | Web App / Mini App. |
|
||||
|
||||
Web App не должен проксироваться на `WEB_SERVER_PORT`.
|
||||
|
||||
## Маршруты вебхуков
|
||||
|
||||
Проксируйте платежные и системные вебхуки на `WEB_SERVER_PORT`:
|
||||
|
||||
- `https://<webhook-domain>/webhook/yookassa` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/yookassa`;
|
||||
- `https://<webhook-domain>/webhook/freekassa` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/freekassa`;
|
||||
- `https://<webhook-domain>/webhook/platega` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/platega`;
|
||||
- `https://<webhook-domain>/webhook/severpay` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/severpay`;
|
||||
- `https://<webhook-domain>/webhook/cryptopay` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/cryptopay`;
|
||||
- `https://<webhook-domain>/webhook/panel` -> `http://remnawave-minishop:<WEB_SERVER_PORT>/webhook/panel`.
|
||||
|
||||
Telegram webhook устанавливается приложением, если задан `WEBHOOK_BASE_URL`. Путь формируется как `https://<webhook-domain>/<BOT_TOKEN>`.
|
||||
|
||||
## Nginx рядом с Remnawave
|
||||
|
||||
Пример upstream и server-блока для домена вебхуков:
|
||||
|
||||
```nginx
|
||||
upstream remnawave-minishop {
|
||||
server remnawave-minishop:8080;
|
||||
}
|
||||
|
||||
map $http_upgrade $connection_upgrade {
|
||||
default upgrade;
|
||||
"" close;
|
||||
}
|
||||
|
||||
server {
|
||||
server_name webhook.domain.com;
|
||||
listen 443 ssl;
|
||||
http2 on;
|
||||
|
||||
ssl_certificate "/etc/nginx/ssl/webhook_fullchain.pem";
|
||||
ssl_certificate_key "/etc/nginx/ssl/webhook_privkey.key";
|
||||
ssl_trusted_certificate "/etc/nginx/ssl/webhook_fullchain.pem";
|
||||
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection $connection_upgrade;
|
||||
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;
|
||||
proxy_set_header X-Forwarded-Host $host;
|
||||
proxy_set_header X-Forwarded-Port $server_port;
|
||||
proxy_send_timeout 60s;
|
||||
proxy_read_timeout 60s;
|
||||
proxy_intercept_errors on;
|
||||
error_page 400 404 500 502 @redirect;
|
||||
|
||||
location / {
|
||||
proxy_pass http://remnawave-minishop$request_uri;
|
||||
}
|
||||
|
||||
location @redirect {
|
||||
return 404;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Для Web App используйте отдельный upstream на `WEBAPP_SERVER_PORT`; пример есть в [webapp.md](webapp.md).
|
||||
|
||||
## SSL для домена вебхуков
|
||||
|
||||
Пример выпуска сертификата через `acme.sh`:
|
||||
|
||||
```bash
|
||||
sudo apt-get install cron socat
|
||||
curl https://get.acme.sh | sh -s email=EMAIL
|
||||
source ~/.bashrc
|
||||
ufw allow 80/tcp
|
||||
ufw reload
|
||||
|
||||
acme.sh --set-default-ca --server letsencrypt
|
||||
acme.sh --issue --standalone -d 'webhook.domain.com' \
|
||||
--key-file /opt/remnawave/nginx/webhook_privkey.key \
|
||||
--fullchain-file /opt/remnawave/nginx/webhook_fullchain.pem
|
||||
```
|
||||
|
||||
Если Nginx панели Remnawave запускается в Docker, добавьте сертификаты в `volumes` сервиса Nginx:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
remnawave-nginx:
|
||||
volumes:
|
||||
- ./webhook_fullchain.pem:/etc/nginx/ssl/webhook_fullchain.pem:ro
|
||||
- ./webhook_privkey.key:/etc/nginx/ssl/webhook_privkey.key:ro
|
||||
```
|
||||
|
||||
После изменения конфигурации перезапустите Nginx:
|
||||
|
||||
```bash
|
||||
cd /opt/remnawave/nginx
|
||||
docker compose down
|
||||
docker compose up -d
|
||||
docker compose logs -f -t
|
||||
```
|
||||
|
||||
## Caddy
|
||||
|
||||
Для схемы с Caddy используйте `docker-compose-caddy.yml` и `Caddyfile`. Caddy публикует наружу `80` и `443`, выпускает TLS-сертификаты и проксирует вебхуки и Web App на разные внутренние порты.
|
||||
|
||||
Пример `Caddyfile`:
|
||||
|
||||
```caddyfile
|
||||
webhook.domain.com {
|
||||
encode zstd gzip
|
||||
reverse_proxy remnawave-minishop:{$WEB_SERVER_PORT:8080}
|
||||
}
|
||||
|
||||
app.domain.com {
|
||||
encode zstd gzip
|
||||
reverse_proxy remnawave-minishop:{$WEBAPP_SERVER_PORT:8081}
|
||||
}
|
||||
```
|
||||
|
||||
В `.env` укажите:
|
||||
|
||||
```env
|
||||
WEBHOOK_BASE_URL=https://webhook.domain.com
|
||||
SUBSCRIPTION_MINI_APP_URL=https://app.domain.com/
|
||||
```
|
||||
|
||||
Запуск:
|
||||
|
||||
```bash
|
||||
docker compose -f docker-compose-caddy.yml up -d --build
|
||||
```
|
||||
|
||||
В BotFather укажите домен Mini App через настройки домена, чтобы он совпадал с `SUBSCRIPTION_MINI_APP_URL`.
|
||||
|
||||
## Проверка
|
||||
|
||||
```bash
|
||||
docker compose ps
|
||||
docker compose logs -f remnawave-minishop
|
||||
```
|
||||
|
||||
Проверьте:
|
||||
|
||||
- бот отвечает в Telegram;
|
||||
- Telegram webhook установлен без ошибок в логах;
|
||||
- платежные вебхуки доходят до приложения;
|
||||
- Remnawave webhook проходит проверку `PANEL_WEBHOOK_SECRET`;
|
||||
- Web App открывается по домену из `SUBSCRIPTION_MINI_APP_URL`;
|
||||
- в BotFather разрешены URL Web App и callback.
|
||||
Reference in New Issue
Block a user