Обзор развертывания Plane на сервере¶

Предварительные требования и основные условия¶

Операционная система: Сервер Linux с возможностью запуска Docker.
Привилегии: Для управления Docker и системными каталогами требуются права root или sudo.
Домен: Развертывание использует зону hostkey.in.
Порты:
Порт внутреннего сервиса: 8080
Порт внешнего HTTPS: 443

FQDN итоговой панели¶

Приложение доступно по следующему полному доменному имени (FQDN):

Формат: plane<Server ID>.hostkey.in
Протокол: HTTPS на порту 443

Структура файлов и каталогов¶

Для конфигурации и данных развертывание использует следующую структуру каталогов:

Каталог данных приложения: /opt/plane
Каталог конфигурации Nginx: /root/nginx
Пользовательская конфигурация Nginx: /data/nginx/user_conf.d
Хранилище SSL-сертификатов: /etc/letsencrypt (подключен как том nginx_secrets)
Файл окружения: /data/nginx/nginx-certbot.env

Процесс установки приложения¶

Приложение развертывается с использованием контейнеров Docker. Процесс развертывания включает настройку окружения Docker и запуск сервисов через конфигурацию docker compose. Версия сервиса прокси соответствует последней доступной тегу образа jonasal/nginx-certbot.

Права доступа и безопасность¶

Каталог Nginx /root/nginx принадлежит пользователю и группе root с правами доступа 0755.
Файл compose.yml, расположенный в /root/nginx, имеет права доступа 0644.
Контейнер Docker работает с параметром network_mode: host, используя сетевой стек хоста напрямую.

Контейнеры Docker и их развертывание¶

Сервисами управляет Docker Compose. Основной контейнер — это Nginx прокси с интеграцией Certbot.

Образ: jonasal/nginx-certbot:latest
Политика перезапуска: unless-stopped
Режим сети: host
Томы:
nginx_secrets отображен на /etc/letsencrypt (Внешний том)
/data/nginx/user_conf.d отображен на /etc/nginx/user_conf.d
Окружение:
CERTBOT_EMAIL установлен в значение hkadm@hostkey.com
Дополнительные переменные окружения загружаются из /data/nginx/nginx-certbot.env

Серверы прокси¶

В качестве обратного прокси для обработки SSL-терминации и маршрутизации используется Nginx с интеграцией Certbot.

Параметр	Значение
Образ сервиса	`jonasal/nginx-certbot:latest`
Email для SSL	`hkadm@hostkey.com`
Путь конфигурации	`/root/nginx/compose.yml`
Каталог пользовательской конфигурации	`/data/nginx/user_conf.d`
Хранилище сертификатов	`/etc/letsencrypt`

Прокси обрабатывает трафик, предназначенный для домена plane<Server ID>.hostkey.in, и маршрутизирует его безопасно через HTTPS.

Настройки прав доступа¶

Каталог /root/nginx: Владелец root:root, права доступа 0755.
Файл /root/nginx/compose.yml: Владелец root:root, права доступа 0644.
Подключение томов зависит от прав доступа файловой системы хоста для каталогов /data/nginx и /etc/letsencrypt.

Расположение файлов конфигурации и данных¶

Основной файл Compose: /root/nginx/compose.yml
Окружение Nginx: /data/nginx/nginx-certbot.env
Пользовательские конфигурации: /data/nginx/user_conf.d
Данные приложения: /opt/plane
SSL-секреты: Хранятся во внешнем томе Docker nginx_secrets, отображаемом на /etc/letsencrypt.

Доступные порты для подключения¶

Порт 443: HTTPS-трафик для публичного интерфейса приложения Plane.
Порт 8080: Порт внутренней коммуникации для серверной части приложения.

Запуск, остановка и обновление¶

Управление сервисами осуществляется с помощью команд Docker Compose внутри каталога /root/nginx.

Запуск сервисов:
```
cd /root/nginx
docker compose up -d
```
Остановка сервисов:
```
cd /root/nginx
docker compose down
```
Обновление сервисов: Для обновления образов контейнеров загрузите последние версии и перезапустите стек:
```
cd /root/nginx
docker compose pull
docker compose up -d
```