Godspen On-Premise

WHAT

Данный проект предоставляет частное развёртывание (On-Premise) сервиса Кодлиан. Развёртывание осуществляется на основе Docker и Docker Compose.

Кодлиан зависит от ES, Redis, MySQL, электронной почты и OSS-сервисов. ES, Redis и MySQL по умолчанию предоставляются контейнерами Docker, см. файл docker-compose.yaml.

Видеоурок

Перейти

HOW

Необходимые условия

• Linux-система или другая Linux-дистрибуция рекомендуется приобрести сервер на Alibaba Cloud, либо macOS или Windows с возможностью установки Docker;
• как минимум 3 ГБ оперативной памяти, 10 ГБ доступного места для хранения данных (если не использовать контейнеры Docker для предоставления всех или части сервисов ES, Redis или MySQL, можно уменьшить объём в соответствии с потребностями. Один узел ES занимает примерно 1 ГБ памяти, по умолчанию запущено два узла);
• Docker:

curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun

• Docker Compose инструкция по установке;
• открытый OSS-сервис Alibaba Cloud открыть;
• открытая служба электронной почты открыть SMTP-службу.

Получение кода

Адрес проекта, проект содержит конфигурацию Docker Compose.

git clone https://github.com/ymm-tech/gods-pen-docker.git

или напрямую скачать и распаковать архив.

Конфигурация

Проект предоставляет два файла конфигурации: config.yaml и nginx.conf.

config.yaml объединяет все зависимости сервиса Кодлиан, такие как Redis, MySQL и другие. Redis, MySQL и ES-сервисы предоставляются соответствующими контейнерами Docker и могут быть использованы с настройками по умолчанию (также можно настроить соответствующие поля самостоятельно и внести изменения в файл docker-compose.yaml или удалить соответствующие сервисы). Электронная почта и OSS не предоставляются контейнерами Docker, необходимо заполнить соответствующие настройки (можно создать собственные или использовать сторонние сервисы).

nginx.conf — это файл конфигурации Nginx, который объединяет несколько внутренних сервисов Кодлиана и является фактическим входом для доставки услуг. По умолчанию он включает в себя минимальную конфигурацию, поддержку статических файлов (включая поддержку HTML5 history и кэширование) и проксирование API-запросов. Если требуется выполнить операции, связанные с доменными именами, можно изменить этот файл для настройки.

Создание локального образа

После завершения настройки необходимо создать локальный образ. В корневом каталоге проекта выполните команду make build или docker-compose build. Процесс создания образа занимает около 4 минут, пожалуйста, проявите терпение.

После первого создания образа, если config.yaml не был изменён, нет необходимости создавать образ повторно.

Запуск сервиса

После создания локального образа можно запустить сервис. В корневом каталоге проекта запустите команду make start-server или docker-compose up -d, чтобы последовательно запустить сервисы.

Процесс запуска сервиса занимает около 3 минут. Можно использовать команду docker logs <container id>, чтобы отслеживать ход выполнения.

Если запуск прошёл успешно, доступ к сервису будет осуществляться по адресу http://<host:port>/admin. Если используется конфигурация nginx.conf по умолчанию, адрес доступа будет http://127.0.0.1/admin.

Остановка сервиса

make stop-server. Приостанавливает работу сервиса, но не удаляет существующие контейнеры. Можно снова запустить сервис с помощью команды make start-server.

Завершение работы сервиса

make remove-server. Удаляет сервис и удаляет существующие контейнеры. Для повторного создания контейнеров и запуска сервиса можно использовать команду make start-server.