Полный список переменных

Переменная

Описание

Пример значения

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

Переменная

Описание

Пример значения

SSO_SERVICE_ENCRYPTION_KEY

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

SSO_SERVICE_ENCRYPTION_KEY=7cdf59ed...cccb8489

SSO_URL

URL по которому будет доступен сервис SSO. Обязателен.

SSO_URL=https://sso.gram.ax

AUTH_METHOD

Метод авторизации в SSO. Необходимо выбрать любой доступный один способ авторизации.

Варианты:

• azure

• adfs

• keycloak

• openid

• ldap

• kerberos

Все параметры связанные с AUTH_METHOD, обязательны.

AUTH_METHOD=azure

CONNECTOR_TYPE

Метод получения списка пользователей. Варианты:

• ldap

• keycloak

• scim

Все параметры связанные с CONNECTOR_TYPE обязательны.

CONNECTOR_TYPE=ldap

Переменная

Описание

Пример значения

AZURE_TOKEN_URL

Урл до эндпоинта для получения токена.

https://login.microsoftonline.com/HohLpGvI-uPW8-vyyn-QBH1-88fuprQzzpu3/oauth2/v2.0/authorize.

AZURE_API_URL

Урл до эндпоинта получения информации по api.

https://login.microsoftonline.com/HohLpGvI-uPW8-vyyn-QBH1-88fuprQzzpu3/oauth2/v2.0/authorize

AZURE_CLIENT_ID

Идентификатор приложения в azure

0FYSAWm1A-1x4k-e14H-0LHe-gf6qwElcYuz.

AZURE_CLIENT_SECRET

Секрет приложения в azure

rY3yh*suIebMk^k0KGoi3azsIBP&FY@odQsgFVdc.

Переменная

Описание

Пример значения

ADFS_CERT

Сертификат, используемый для аутентификации в ADFS

ADFS_ENTRYPOINT

Точка входа для аутентификации

Наример: https://adfs.gram.ax/adfs/ls/.

ADFS_ISSUER

Идентификатор ADFS

https://adfs.gram.ax/.

ADFS_CALLBACK_URL

URL для обратного вызова после успешной аутентификации

https://app.gram.ax/auth/cb.

Переменная

Описание

Пример значения

KEYCLOAK_SERVER_URL

URL сервера Keycloak

https://keycloak.gram.ax/auth/.

KEYCLOAK_REALM

Имя Realm в Keycloak

gramax.

KEYCLOAK_CLIENT_ID

Идентификатор клиента Keycloak

KEYCLOAK_USE_ACCESS_TOKEN_INFO

Необходимо ли брать информацию о пользователе из access_token

KEYCLOAK_USE_ACCESS_TOKEN_INFO=true

Переменная

Описание

Пример значения

OPEN_ID_SERVER_URL

URL сервера OpenID

https://keycloak.gram.ax/auth/.

OPEN_ID_REALM

Имя Realm в OpenID

gramax.

OPEN_ID_CLIENT_ID

Идентификатор клиента OpenID

OPEN_ID_CLIENT_SECRET

Секрет клиента OpenID.

Переменная

Описание

Пример значения

LDAP_URL

URL LDAP-сервера.

ldap://ldap.example.com:389 или ldaps://ldap.example.com:636.

LDAP_ADMIN_DN

DN административного пользователя с правами поиска в каталоге.

gramax@gramax.ru

LDAP_ADMIN_PASSWORD

пароль административного пользователя, указанного в LDAP_ADMIN_DN.

secretAdminPass.

LDAP_USER_SEARCH_BASE

DN базовой точки поиска пользователей.

ou=users,dc=example,dc=com.

LDAP_USERNAME_ATTRIBUTE

Атрибут пользователя.

Например, samaccountname, cn, mail. По нему будет поиск пользователя, samaccountname.

LDAP_USER_DN

DN конкретного пользователя, если известен напрямую.

OU=Enabled,OU=GRAMAX-USERS,DC=gramax,DC=local.

LDAP_GROUP_SEARCH_BASE

DN базовой точки поиска групп. Если указан, после аутентификации будет выполнен поиск групп.

ou=groups,dc=example,dc=com.

LDAP_GROUP_CLASS

Класс объекта групповой записи (например, groupOfNames, groupOfUniqueNames).

groupOfNames.

LDAP_GROUP_MEMBER_ATTRIBUTE

Имя атрибута в записи группы, содержащего членов группы.

member

LDAP_GROUP_MEMBER_USER_ATTRIBUTE

Атрибут в записи пользователя, который сопоставляется с LDAP_GROUP_MEMBER_ATTRIBUTE.

dn.

LDAP_ATTRIBUTES

Список атрибутов пользователя (через запятую), которые нужно возвращать при поиске. Если не указано, возвращаются все.

cn,sn,mail.

Переменная

Описание

Пример значения

KERBEROS_REALM

Kerberos realm (домен Active Directory). Должен быть в UPPERCASE

COMPANY.LOCAL

KERBEROS_SERVICE_PRINCIPAL

Service Principal Name (SPN) для веб-сервиса. Формат: HTTP/hostname@REALM. Hostname в lowercase, realm в UPPERCASE

HTTP/gramax.company.local@COMPANY.LOCAL

KRB5_KTNAME

Environment variable для Kerberos библиотеки. Формат: FILE:/путь/к/keytab

FILE:/opt/gramax/config/gramax.keytab

Переменная

Описание

Пример значения

LDAP_URL

URL LDAP-сервера.

ldap://ldap.example.com:389 или ldaps://ldap.example.com:636.

LDAP_ADMIN_DN

DN пользователя с правами поиска в каталоге.

gramax@gramax.ru

LDAP_ADMIN_PASSWORD

Пароль пользователя, указанного в LDAP_ADMIN_DN

secretAdminPass.

LDAP_USER_SEARCH_BASE

DN базовой точки поиска пользователей.

ou=users,dc=example,dc=com.

Переменная

Описание

Пример значения

KEYCLOAK_SERVER_URL

URL сервера Keycloak.

https://keycloak.gram.ax/auth/.

KEYCLOAK_REALM

Имя Realm в Keycloak.

gramax.

KEYCLOAK_API_TOKEN

Токен доступа.

Можно создать используя

Переменная

Описание

Пример значения

SCIM_SERVER_URL

URL сервера SCIM.

https://scim.gram.ax/auth/

SCIM_TOKEN

Токен доступа. Используется либо он, либо SCIM_ADMIN_LOGIN и SCIM_ADMIN_PASSWORD для авторизации через Basic.

SCIM_GET_USERS_FILTER

Фильтр для поиска пользователей. Если не задан, используется userName co "${searchSubstring}", где ${searchSubstring} заменяется на строку, переданную пользователем при поиске.

SCIM_ADMIN_LOGIN

Username, если используется Basic-авторизация (необязательно, используется вместо SCIM_TOKEN).

SCIM_ADMIN_PASSWORD

Password, если используется Basic авторизация (необязательно, используется вместо SCIM_TOKEN).

Переменная

Описание

Пример значения

LOG_TYPE

Формат логов.

Варианты:

• default

• cef

По умолчанию: default

LOG_LEVEL

Минимальный уровень логирования.

Варианты:

• debug

• info

• warn

• error

• fatal

По умолчанию: info

LOG_TRANSPORTER

Канал вывода логов.

Варианты:

• console

• syslog

По умолчанию: console

LOG_SYSLOG_HOST

Хост Syslog-сервера.

По умолчанию: 127.0.0.1

LOG_SYSLOG_PORT

Порт Syslog-сервера.

По умолчанию: 514

LOG_SYSLOG_PROTOCOL

Протокол соединения с Syslog (поддерживаются IPv4/IPv6 и TLS).

Варианты:

• udp4

• tcp4

• tls4

• udp6

• tcp6

• tls6

По умолчанию: udp4

LOG_SYSLOG_APP_NAME

Имя приложения, отображаемое в сообщениях Syslog.

По умолчанию: gramax

Переменная

Описание

Пример значения

AUTO_PULL_TOKEN

Пользовательский токен.

glpat-3Ax2PoY1h75JqpXG3X-r

AUTO_PULL_INTERVAL

Интервал автоматической синхронизации. Если не указан, каталоги будут обновляться каждые 3 минуты. Указывается в секундах.

120

AUTO_PULL_USERNAME

При методе аутентификации через логин и пароль:

AUTO_PULL_USERNAME — укажите имя пользователя. AUTO_PULL_TOKEN — укажите пароль пользователя

autopull

DISABLE_SEO

Отключает автоматическую генерацию sitemap.xml и robots.txt для индексации поисковыми системами. При true портал не индексируется.

По умолчанию: true

YANDEX_METRIC_COUNTER

Идентификатор счетчика Яндекс Метрики. Используется для отправки аналитических событий.

AI_TOKEN

Токен авторизации. Укажите здесь то же значение, что и в AUTH__ADMIN__TOKEN для LLM-сервиса.

AI_SERVER_URL

URL для доступа к LLM-сервису.

По умолчанию: {GES_URL}/ai

AI_INSTANCE_NAME

Уникальный идентификатор вашего портала. Это позволяет одному LLM-сервису работать с несколькими независимыми порталами Gramax. Придумайте любое уникальное имя, например, my-docs-portal.

GES_REFRESH_INTERVAL

Интервал синхронизации докпортала с настройками Gramax Enterprise Server. Задается в секундах. По умолчанию установлен на 600сек.

Переменная

Описание

Пример значения

VAULT_API_VERSION

Версия API Vault, используемая для взаимодействия с сервером.

v1

VAULT_TOKEN

Токен доступа для аутентификации в Vault.

s.NG8kghWwZVZHX1wGnGzY9k5u

VAULT_ENDPOINT

URL-адрес сервера Vault.

https://vault.gram.ax

VAULT_PATH

Путь к секрету в Vault, по которому выполняется чтение данных.

secret/data/gramax/ldap

VAULT_MOUNT_PATH

Монтируемый путь (mount path) для KV-хранилища, если отличается от secret.

secret

Переменная

Описание

Пример значения

CONFLUENCE_CLIENT_ID

Идентификатор клиента для подключения к API Confluence. Используется при аутентификации.

CONFLUENCE_CLIENT_SECRET

Секрет клиента, соответствующий CLIENT_ID, для авторизации в Confluence.

CONFLUENCE_REDIRECT_URI

URL перенаправления, используемый при OAuth-авторизации с Confluence.

NOTION_CLIENT_ID

Идентификатор клиента для подключения к API Notion. Используется при аутентификации.

NOTION_CLIENT_SECRET

Секрет клиента, соответствующий CLIENT_ID, для авторизации в Notion.

NOTION_REDIRECT_URI

URL перенаправления, используемый при OAuth-авторизации с Notion.

Переменная

Описание

Пример значения

VECTORDB__TYPE

Тип векторной БД.

По умолчанию: qdrant.

VECTORDB__HOST

Адрес для подключения к БД Qdrant.

По умолчанию:

http://enteprise-gramax-qdrant для Helm-чарта.

EMBEDDING__TYPE

Тип провайдера для создания эмбеддингов.

Варианты:

• openai: для OpenAI и любых других API-совместимых сервисов (например, Deepseek, OpenRouter).

• ollama: для локально запущенного сервиса Ollama.

EMBEDDING__TYPE=openai

EMBEDDING__MODEL

Название модели, которую будет использовать провайдер. Модель должна поддерживать создание эмбеддингов (Embeddings).

Примечание: Список доступных моделей и их названия смотрите в документации вашего провайдера (OpenAI, Ollama и т.д.).

text-embedding-3-large, text-embedding-3-small, mxbai-embed-large

EMBEDDING__HOST

Адрес API-сервера провайдера. Нужно указывать для OpenAI-совместимых провайдеров (кроме самого OpenAI) или для удаленного Ollama.

https://api.deepseek.com/v1, http://my-ollama-host:11434.

EMBEDDING__APIKEY

API-ключ для доступа к сервису провайдера. Некоторые провайдеры могут требовать его наличие, даже если он не используется. В таком случае можно указать любую строку.

EMBEDDING__SOCKSPROXYURL

Адрес SOCKS5-прокси. Полезно, если доступ к API провайдера возможен только через прокси-сервер (например, из-за корпоративных ограничений или блокировок).

Формат: socks5://user:password@host:port

socks5://proxy_user:proxy_pass@192.168.1.1:1080

EMBEDDING__QUERYTEMPLATE

EMBEDDING__DOCUMENTTEMPLATE

EMBEDDING__DIMENSIONS

Размерность векторов, которую создает модель. Это значение обычно указано в документации к модели.

1536

FEATURE__SENDEMBEDDINGDIMENSIONS

CHAT__TYPE

Тип провайдера.

Значение: openai (поддерживает OpenAI и совместимые с ним сервисы).

CHAT__HOST

Адрес API-сервера провайдера. Нужно указывать для OpenAI-совместимых провайдеров (кроме самого OpenAI) или для удаленного Ollama.

https://api.deepseek.com/v1, http://my-ollama-host:11434.

CHAT__MODEL

Название модели, которая будет использоваться для генерации текста.

gpt-4o, gpt-3.5-turbo.

CHAT__APIKEY

API-ключ для доступа к сервису провайдера. Некоторые провайдеры могут требовать его наличие, даже если он не используется. В таком случае можно указать любую строку

CHAT__SOCKSPROXYURL

Адрес SOCKS5-прокси. Полезно, если доступ к API провайдера возможен только через прокси-сервер (например, из-за корпоративных ограничений или блокировок).

Формат: socks5://user:password@host:port

AUTH__ADMIN__TOKEN

Cекретный токен для авторизации запросов от Gramax к LLM-сервису. Придумайте надежное строковое значение.

Переменная

Описание

Пример значения

BUGSNAG_API_KEY

API-ключ для отправки ошибок в Bugsnag.

123abc456def789ghi012jkl345mno678

MATOMO_SITE_ID

Идентификатор сайта в Matomo (используется для сбора аналитики).

5

MATOMO_URL

URL инстанса Matomo.

https://matomo.gram.ax

MATOMO_CONTAINER_URL

URL контейнера Matomo Tag Manager.

https://matomo.gram.ax/js/container_ABC.js

ELASTIC_SEARCH_API_URL

URL API сервера Elasticsearch.

https://es.gram.ax:9200

ELASTIC_SEARCH_INSTANCE_NAME

Имя инстанса или индекс, используемый в Elasticsearch.

gramax-logs

ELASTIC_SEARCH_USERNAME

Имя пользователя для доступа к Elasticsearch.

elastic_user

ELASTIC_SEARCH_PASSWORD

Пароль пользователя для доступа к Elasticsearch.

strongPassword123