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

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

• Операционная система: Ubuntu (совместимая с менеджером пакетов apt).

• Привилегии: Для установки и конфигурации требуется доступ root.

• Домен: Приложение настроено для зоны hostkey.in.

• Порты:

• Внутренняя коммуникация: 8000

• Внешний доступ по HTTPS: 443

FQDN конечной панели¶

Полное доменное имя (FQDN) для доступа к панели имеет следующий формат: brainycp<Server ID>.hostkey.in:443

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

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

• Каталог установки приложения: /usr/local/brainycp

• Расположение скрипта установки: /root/install.sh

• Каталог конфигурации Nginx: /root/nginx

• Каталог пользовательской конфигурации Nginx: /data/nginx/user_conf.d

• Точка монтирования тома с секретами Let's Encrypt: /etc/letsencrypt (отображается из nginx_secrets)

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

Приложение BrainyCP устанавливается с помощью shell-скрипта, предоставленного разработчиком. Процесс включает следующие шаги:

1. Проверьте наличие каталога установки /usr/local/brainycp.

2. Если каталог отсутствует, убедитесь, что утилита wget установлена.

3. Загрузите скрипт установки с адреса http://core.brainycp.com/install.sh в /root/install.sh.

4. Запустите установщик в неинтерактивном режиме с помощью команды:

   yes | bash ./install.sh
   

5. Немедленно перезагрузите сервер после успешной установки для завершения настройки.

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

Обратный прокси и управление SSL обрабатываются через контейнеры Docker с использованием конфигурации docker compose.

• Расположение файла Compose: /root/nginx/compose.yml

• Имя сервиса: nginx

• Образ: jonasal/nginx-certbot:latest

• Политика перезапуска: unless-stopped

• Режим сети: host

• Переменные окружения:

• CERTBOT_EMAIL: hkadm@hostkey.com

• Точки монтирования томов:

• nginx_secrets (внешний том) отображается в /etc/letsencrypt

• /data/nginx/user_conf.d отображается в /etc/nginx/user_conf.d

Для запуска стека контейнеров выполните следующую команду из каталога /root/nginx:

docker compose up -d

Прокси-серверы¶

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

• Цель прокси: Конфигурация Nginx перенаправляет трафик на внутренний сервис приложения по адресу http://127.0.0.1:8002.

• Файл конфигурации: Конфигурация конкретного сайта находится по пути /data/nginx/user_conf.d/brainycp<Server ID>.hostkey.in.conf.

• Управление SSL: Осуществляется автоматически контейнером nginx-certbot с использованием тома letsencrypt.

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

Управление службами для прокси-слоя выполняется с помощью команд 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
  

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

• Порт 443: Внешний доступ по HTTPS для панели BrainyCP.

• Порт 8000: Внутренний порт, определенный для приложения (используется системой во внутреннем контуре).

• Порт 8002: Внутренний порт, используемый прокси Nginx для пересылки запросов на бэкенд приложения.