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

• 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...

• AUTH_METHOD — метод авторизации в SSO. Все параметры, связанные с AUTH_METHOD, обязательны. Варианты: azure, adfs, keycloak, openid, ldap, kerberos. Пример: AUTH_METHOD=azure

• CONNECTOR_TYPE — метод получения списка пользователей. Все параметры, связанные с CONNECTOR_TYPE, обязательны. Варианты: ldap, keycloak, scim. Пример: CONNECTOR_TYPE=ldap

При AUTH_METHOD = azure

• AZURE_AUTHORIZATION_URL — URL эндпоинта авторизации. Пример: https://login.microsoftonline.com/HohLpGvI.../oauth2/v2.0/authorize

• AZURE_TOKEN_URL — URL эндпоинта для получения токена. Пример: https://login.microsoftonline.com/HohLpGvI.../oauth2/v2.0/token

• AZURE_API_URL — URL эндпоинта получения информации по API. Пример: https://graph.microsoft.com/v1.0

• AZURE_CLIENT_ID — идентификатор приложения в Azure. Пример: 0FYSAWm1A-1x4k-e14H-0LHe-gf6qwElcYuz

• AZURE_CLIENT_SECRET — секрет приложения в Azure. Пример: rY3yh*suIebMk^k0KGoi3azsIBP&FY@odQsgFVdc

При AUTH_METHOD = adfs

• 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

При AUTH_METHOD = keycloak

• 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

При AUTH_METHOD = openid

• 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.

При AUTH_METHOD = ldap

• LDAP_URL — URL LDAP-сервера. Пример: ldap://ldap.example.com:389 или ldaps://ldap.example.com:636

• LDAP_ADMIN_DN — DN административного пользователя с правами поиска. Пример: gramax@gramax.ru

• LDAP_ADMIN_PASSWORD — пароль административного пользователя. Пример: secretAdminPass

• LDAP_USER_SEARCH_BASE — DN базовой точки поиска пользователей. Пример: ou=users,dc=example,dc=com

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

• 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

• LDAP_GROUP_MEMBER_ATTRIBUTE — атрибут в записи группы, содержащий членов группы. Пример: member

• LDAP_GROUP_MEMBER_USER_ATTRIBUTE — атрибут пользователя, сопоставляемый с LDAP_GROUP_MEMBER_ATTRIBUTE. Пример: dn

• LDAP_ATTRIBUTES — список атрибутов пользователя через запятую. Если не указано, возвращаются все. Пример: cn,sn,mail

При AUTH_METHOD = kerberos

• KERBEROS_REALM — Kerberos realm (домен Active Directory). Должен быть в UPPERCASE. Пример: COMPANY.LOCAL

• KERBEROS_SERVICE_PRINCIPAL — Service Principal Name (SPN). Формат: HTTP/hostname@REALM. Пример: HTTP/gramax.company.local@COMPANY.LOCAL

• KRB5_KTNAME — переменная для Kerberos библиотеки. Формат: FILE:/путь/к/keytab. Пример: FILE:/opt/gramax/config/gramax.keytab

• KERBEROS_REALM должен точно совпадать с доменом Active Directory в UPPERCASE

• KERBEROS_SERVICE_PRINCIPAL должен совпадать с SPN, зарегистрированным в Active Directory

• Путь в KRB5_KTNAME должен начинаться с префикса FILE:

• Keytab файл должен иметь права доступа 600

При CONNECTOR_TYPE=ldap

• 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_GROUP_CLASS — LDAP-класс объектов для поиска групп. Пример: group

• LDAP_GROUP_SEARCH_BASE — DN базовой точки поиска групп. Пример: ou=groups,dc=example,dc=com

• LDAP_SEARCH_GROUP_LIMIT — максимальное количество групп при поиске. Пример: 15

При CONNECTOR_TYPE=keycloak

• KEYCLOAK_SERVER_URL — URL сервера Keycloak. Пример: https://keycloak.gram.ax/auth/

• KEYCLOAK_REALM — имя Realm в Keycloak. Пример: gramax

• KEYCLOAK_API_TOKEN — токен доступа.

При CONNECTOR_TYPE=scim

• SCIM_SERVER_URL — URL сервера SCIM. Пример: https://scim.gram.ax/auth/

• SCIM_TOKEN — токен доступа (используется вместо SCIM_ADMIN_LOGIN + SCIM_ADMIN_PASSWORD).

• SCIM_GET_USERS_FILTER — фильтр для поиска пользователей. По умолчанию: userName co "${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_TOKEN при этом содержит пароль). Пример: autopull

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

• YANDEX_METRIC_COUNTER — идентификатор счётчика Яндекс Метрики.

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

• AI_SERVER_URL — URL для доступа к LLM-сервису. По умолчанию: {GES_URL}/ai

• AI_INSTANCE_NAME — уникальный идентификатор портала. Позволяет одному LLM-сервису работать с несколькими порталами. Пример: my-docs-portal

• GES_REFRESH_INTERVAL — интервал синхронизации портала с настройками GES в секундах. По умолчанию: 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 — монтируемый путь для KV-хранилища, если отличается от secret. Пример: secret

• CONFLUENCE_CLIENT_ID — идентификатор клиента для подключения к API Confluence.

• CONFLUENCE_CLIENT_SECRET — секрет клиента для авторизации в Confluence.

• CONFLUENCE_REDIRECT_URI — URL перенаправления при OAuth-авторизации с Confluence.

• NOTION_CLIENT_ID — идентификатор клиента для подключения к API Notion.

• NOTION_CLIENT_SECRET — секрет клиента для авторизации в Notion.

• NOTION_REDIRECT_URI — URL перенаправления при OAuth-авторизации с Notion.

• VECTORDB__TYPE — тип векторной БД. По умолчанию: qdrant

• VECTORDB__HOST — адрес для подключения к БД Qdrant. По умолчанию: http://enteprise-gramax-qdrant для Helm-чарта.

• EMBEDDING__TYPE — тип провайдера для создания эмбеддингов: openai (для OpenAI и совместимых сервисов) или ollama (для локального Ollama). Пример: EMBEDDING__TYPE=openai

• EMBEDDING__MODEL — название модели для создания эмбеддингов. Пример: text-embedding-3-large, mxbai-embed-large

• EMBEDDING__HOST — адрес API-сервера провайдера (для OpenAI-совместимых или удалённого Ollama). Пример: https://api.deepseek.com/v1

• EMBEDDING__APIKEY — API-ключ для доступа к сервису провайдера.

• EMBEDDING__SOCKSPROXYURL — адрес SOCKS5-прокси. Формат: 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.

• CHAT__HOST — адрес API-сервера провайдера. Пример: https://api.deepseek.com/v1

• CHAT__MODEL — название модели для генерации текста. Пример: gpt-4o

• CHAT__APIKEY — API-ключ для доступа к сервису провайдера.

• CHAT__SOCKSPROXYURL — адрес SOCKS5-прокси. Формат: socks5://user:password@host:port

• AUTH__ADMIN__TOKEN — секретный токен для авторизации запросов от 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