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

Для разворачивания 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 (портал документации, браузерная версия и Gramax Enterprise Server). Запятая в конце не нужна. Обязателен.

https://some-instance.gram.ax,https://another-instance.gram.ax

LICENSE_KEY

Лицензионный ключ Gramax Enterprise Server. Используется только для подстановки в конфигурацию. Выдаётся при покупке. Обязателен

765d562b9092eec3…

GIT_SERVER_TOKEN

Токен доступа к Git-серверу на стороне клиента. Нужен для чтения/клонирования репозиториев (доступ к API). Обязателен.

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:

путь до репозитория с настройками в GitLab. Должен быть создан до инициализации. Хранится в формате «группа/название-репозитория». Обязателен.

dr/gramax-yaml-manager

ENTERPRISE_SERVICE_ENCRYPTION_KEY

Ключ, используется для безопасной передачи данных между сервисами. Обязателен.

5caf59ed...cddb8489

COOKIE_SECRET

Ключ для шифрования секретов пользователя в куках. Если не указан, используется ., рекомендуется заменить его на 32-байтный ключ (можно сгенерировать, используя openssl rand -hex 32

397b6f3bf51a73b9352e997f837f1d78ac0b68f12058d33a89dd33ade48ff928

Запуск

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

Перед первым запуском необходимо авторизоваться в нашем хранилище образов (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.