docs: refactor docs structure
This commit is contained in:
@@ -1,12 +1,12 @@
|
||||
# Deploy examples
|
||||
# Примеры Docker Compose
|
||||
|
||||
Каноничная документация по вариантам запуска живет в [docs/deploy-examples/index.md](../../docs/deploy-examples/index.md).
|
||||
Каноничная документация по вариантам запуска живет в [docs/deployment.md](../../docs/deployment.md).
|
||||
|
||||
Эта папка хранит только рабочие compose-примеры и конфиги. Подробное описание не дублируется здесь, чтобы сайт документации и навигация из README использовали один источник.
|
||||
|
||||
| Папка | Документация |
|
||||
| --- | --- |
|
||||
| `caddy` | [Caddy](../../docs/deploy-examples/caddy.md) |
|
||||
| `nginx` | [Nginx](../../docs/deploy-examples/nginx.md) |
|
||||
| `newt` | [Pangolin / Newt](../../docs/deploy-examples/newt.md) |
|
||||
| `no-proxy` | [No proxy](../../docs/deploy-examples/no-proxy.md) |
|
||||
| `caddy` | [Развертывание с Caddy](../../docs/deployment.md#caddy-рекомендуемый-вариант) |
|
||||
| `nginx` | [Развертывание с Nginx](../../docs/deployment.md#nginx) |
|
||||
| `newt` | [Развертывание через Pangolin / Newt](../../docs/deployment.md#pangolin--newt) |
|
||||
| `no-proxy` | [Запуск без обратного прокси](../../docs/deployment.md#без-обратного-прокси) |
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Caddy
|
||||
|
||||
Каноничная инструкция: [docs/deploy-examples/caddy.md](../../../docs/deploy-examples/caddy.md).
|
||||
Каноничная инструкция: [docs/deployment.md](../../../docs/deployment.md#caddy-рекомендуемый-вариант).
|
||||
|
||||
Файлы этого примера остаются рядом: `docker-compose.yml`, `.env.example` и `Caddyfile`.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Pangolin / Newt
|
||||
|
||||
Каноничная инструкция: [docs/deploy-examples/newt.md](../../../docs/deploy-examples/newt.md).
|
||||
Каноничная инструкция: [docs/deployment.md](../../../docs/deployment.md#pangolin--newt).
|
||||
|
||||
Файлы этого примера остаются рядом: `docker-compose.yml` и `.env.example`.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# Nginx
|
||||
|
||||
Каноничная инструкция: [docs/deploy-examples/nginx.md](../../../docs/deploy-examples/nginx.md).
|
||||
Каноничная инструкция: [docs/deployment.md](../../../docs/deployment.md#nginx).
|
||||
|
||||
Файлы этого примера остаются рядом: `docker-compose.yml`, `.env.example`, `nginx.conf.template` и папка `ssl/` для сертификатов.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# TLS certificates
|
||||
|
||||
Каноничная инструкция по Nginx: [docs/deploy-examples/nginx.md](../../../../docs/deploy-examples/nginx.md).
|
||||
Каноничная инструкция по Nginx: [docs/deployment.md](../../../../docs/deployment.md#nginx).
|
||||
|
||||
Кладите сертификаты в подпапки, совпадающие с `WEBHOOK_HOST` и `MINIAPP_HOST`:
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
# No proxy
|
||||
# Без обратного прокси
|
||||
|
||||
Каноничная инструкция: [docs/deploy-examples/no-proxy.md](../../../docs/deploy-examples/no-proxy.md).
|
||||
Каноничная инструкция: [docs/deployment.md](../../../docs/deployment.md#без-обратного-прокси).
|
||||
|
||||
Файлы этого примера остаются рядом: `docker-compose.yml` и `.env.example`.
|
||||
|
||||
Reference in New Issue
Block a user