Быстрый старт

Для разворачивания GES при помощи docker-compose на своем сервере необходимо иметь:

  • Docker (а также Docker Compose 2.0 и выше).

  • Учетные данные для registry.gram.ax.

  • Лицензионный ключ.

Скачивание

Скачайте docker-compose файл для запуска при помощи команды curl -o docker-compose.yaml https://gram.ax/enterprise-docker-compose.yaml -o .env https://gram.ax/enterprise.env.

Настройка

Перед запуском установите следующие переменные при помощи переменных сред, либо при помощи .env файла.

Основные параметры

  • CLIENT_NAME — логин клиента Gramax Enterprise Server. Используется для аутентификации в Docker Registry и при подстановке значений в переменные конфигурации. Выдается при покупке. Обязателен. Пример: gramax

  • GES_URL — URL, на котором будет доступен GES. Обязателен. Пример: https://enterprise.gramax.local

  • AUTH_SERVICE_URL — URL, по которому будет доступен сервис auth. Пример: https://ges.gram.ax/auth

  • DIAGRAM_RENDERER_SERVICE_URL — URL, по которому будет доступен сервис Diagram-renderer. Пример: https://ges.gram.ax/diagram-renderer

  • ALLOWED_GRAMAX_URLS — URL-адреса инстансов Gramax (портал документации, браузерная версия и GES), через запятую. Обязателен. Пример: https://some-instance.gram.ax,https://another-instance.gram.ax

  • LICENSE_KEY — лицензионный ключ Gramax Enterprise Server. Выдается при покупке. Обязателен. Пример: 765d562b9092eec3…

  • GIT_SERVER_TOKEN — токен доступа к Git-серверу для чтения/клонирования репозиториев. Обязателен. Пример: glpat-...

  • GES_ADMIN_EMAILS — почты владельцев воркспейса через запятую. Устанавливаются в конфиг только при первом запуске. Обязателен. Пример: admin1@gramax.local,admin2@gramax.local

  • GIT_SERVER_URL — адрес GitLab-сервера для внешнего хранилища. Обязателен. Пример: https://gitlab.example.com

  • ENTERPRISE_STORAGE_TYPE — тип хранилища конфигураций: gitlab или local. Обязателен. Пример: gitlab

  • ENTERPRISE_CONFIG_PATH — при ENTERPRISE_STORAGE_TYPE=local: путь до папки с настройками GES на виртуальной машине. Обязателен. По умолчанию: /app/config

  • GIT_PROJECT_PATH — при ENTERPRISE_STORAGE_TYPE=gitlab: путь до репозитория с настройками в формате «группа/название-репозитория». Должен быть создан до инициализации. Обязателен. Пример: dr/gramax-yaml-manager

  • GIT_PROJECT_BRANCH — ветка репозитория GIT_PROJECT_PATH, если отличается от master. По умолчанию: master. Пример: main

  • ENTERPRISE_SERVICE_ENCRYPTION_KEY — ключ для безопасной передачи данных между сервисами. Обязателен. Пример: 5caf59ed...cddb8489

  • COOKIE_SECRET — ключ для шифрования секретов пользователя в куках. Рекомендуется 32-байтный ключ (openssl rand -hex 32). Пример: 397b6f3bf51a73b9...

Запуск

Авторизация в хранилище образов

Перед первым запуском необходимо авторизоваться в нашем хранилище образов (registry).

  1. На хосте, где выполняете развертывание, выполните команду:

    docker login registry.gram.ax

  2. Введите учетные данные:

    • Login: значение переменной CLIENT_NAME

    • Password: токен, отправленный в сообщении вместе с лицензионным ключом

Если данные введены корректно, Docker выведет сообщение об успешной авторизации, например:

Login Succeeded

После выставления переменных сред GES можно запустить командой docker compose up -d.

Конфигурационные файлы создаются автоматически при первом запуске. При этом обязательные параметры подставляются из .env файла.

Обновление

Для обновления GES можно использовать docker compose up --pull=always.