Переменные окружения

Многие настройки в Glarus BI можно просматривать и изменять в Панели Администратора или же устанавливать с помощью переменных окружения. Переменные окружения всегда имеют приоритет. Обратите внимание, что переменные окружения не сохраняются в базе данных приложения.

Установка переменных окружения может быть выполнена различными способами, в зависимости от того, как запускается Glarus BI.

JAR file:

# Mac, Linux и другие Unix машины
export MB_SITE_NAME="Awesome Company"
# Windows Powershell
$env:MB_SITE_NAME="Awesome Company"
# Windows batch/cmd
set MB_SITE_NAME="Awesome Company"

java -jar glarusBI.jar

Либо как атрибут Java, в этом случае он будет работать на всех системах:

java -DMB_SITE_NAME="Awesome Company" -jar glarusBI.jar

Docker:

docker run -d -p 3000:3000 -e MB_SITE_NAME="Awesome Company" --name glarusbi glarusbi/glarusbi

MAX_SESSION_AGE

Тип: integer
Значение по умолчанию: 20160

Время жизни сессии, определенное в минутах (по умолчанию - 2 недели), через которое потребуется повторная аутентификации пользователя.

Примечание: эта настройка не является таймаутом простоя / неактивности. Если вы установите это на 15 минут, ваши пользователи должны будут повторно аутентифицироваться каждые 15 минут.

Используйте MB_SESSION_TIMEOUT, чтобы контролировать таймаут при неактивности пользователя. Используйте MB_SESSION_COOKIES для инвалидации сессии при закрытии браузера.

Также см. Изменение инвалидации сессии.

MB_ADMIN_EMAIL

Тип: string
Значение по умолчанию: null

Почтовый адрес, к которому пользователи должны обращаться в случае возникновения проблем.

MB_AGGREGATED_QUERY_ROW_LIMIT

Тип: integer
Значение по умолчанию: 10000

Максимальное количество строк, возвращаемых для агрегированных запросов через API. Должно быть меньше 1048575. Эта переменная среды также определяет количество строк, которые Glarus BI включает в вложения подписки на дашборды.

См. MB_UNAGGREGATED_QUERY_ROW_LIMIT.

MB_ANON_TRACKING_ENABLED

Тип: boolean
Значение по умолчанию: true

Включить сбор анонимных данных.

MB_API_KEY

Тип: string
Значение по умолчанию: null

Валидация клиента через заголовок запроса X-Glarus BI-Apikey. Если заголовок присутствует, то он проверяется по MB_API_KEY. Если есть совпадение, то запрос продолжается, иначе он блокируется с ответом 403 Forbidden.

MB_APPLICATION_COLORS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "{}"

Объект JSON, описывающий основные цвета, используемые в диаграммах и во всем Glarus BI. Примеры:

Для изменения цветов пользовательского интерфейса:

{
   "brand":"#ff003b",
   "filter":"#FF003B",
   "summarize":"#FF003B"
}

Для изменения цветов диаграмм:

{
   "accent0":"#FF0005",
   "accent1":"#E6C367",
   "accent2":"#B9E68A",
   "accent3":"#8AE69F",
   "accent4":"#8AE6E4",
   "accent5":"#8AA2E6",
   "accent6":"#B68AE6",
   "accent7":"#E68AD0"
}

MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE

Тип: integer
Значение по умолчанию: 15
Начиная с версии: v35.0

Максимальное количество соединений с базой данных приложения Glarus BI.

Увеличьте это значение, если вы заметите, что используются все или бо́льшая часть соединений. Это может ухудшить как производительность Glarus BI, так и реактивность элементов интерфейса.

Чтобы узнать, сколько соединений используется, проверьте журналы Glarus BI и найдите строки, содержащие следующее: App DB connections: 12/15 . В этом примере указано, что используются 12 из 15 доступных соединений.

Смотрите MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE для установки максимального числа соединений к базе данных Glarus BI.

MB_APPLICATION_FAVICON_URL

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "frontend_client/favicon.ico"

Путь или URL к файлу favicon.

MB_APPLICATION_FONT

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "Lato"
Начиная с версии: v44.0

Изменение шрифтов в Glarus BI. См. Шрифты.

MB_APPLICATION_FONT_FILES

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "{}"
Начиная с версии: v44.0

Указывает, какие файлы шрифтов использовать для различных стилей. Пример:

[
  {
     "src": "https://example.com/resources/font-400",
     "fontFormat": "ttf",
     "fontWeight": 400,
  },
  {
     "src": "https://example.com/resources/font-700",
     "fontFormat": "woff",
     "fontWeight": 700,
  }
]

См. Шрифты.

MB_APPLICATION_LOGO_URL

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "app/assets/img/logo.svg"

Путь или URL к файлу логотипа.

MB_APPLICATION_NAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "Glarus BI"

Заменяет слово Glarus BI на название вашего приложения.

MB_ASYNC_QUERY_THREAD_POOL_SIZE

Тип: integer
Значение по умолчанию: 50
Начиная с версии: v35.0

Максимальное количество асинхронных потоков на сервере Jetty. Если не установлено, то будет использоваться MB_JETTY_MAXTHREADS.

MB_BREAKOUT_BIN_WIDTH

Тип: double
Значение по умолчанию: 10.0

Когда используется стратегия группировки по умолчанию для поля типа Координата (например, Широта и Долгота), то это число будет использоваться как ширина группы по умолчанию (в градусах).

MB_BREAKOUT_BINS_NUM

Тип: integer
Значение по умолчанию: 8

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

MB_CHECK_FOR_UPDATES

Тип: boolean
Значение по умолчанию: true

Проверка доступности новых версий Glarus BI.

MB_COLORIZE_LOGS

Тип: boolean
Значение по умолчанию: true

Цветовая гамма журналов. При установке в false убирает цвета при выводе логов. Отключено в Windows. Связано с MB_EMOJI_IN_LOGS.

MB_CONFIG_FILE_PATH

Тип: string
Значение по умолчанию: config.yml

Этот функционал требует установки флага config-text-file в вашем токене.

MB_CUSTOM_FORMATTING

Тип: string
Значение по умолчанию: "{}"

Объект JSON с ключами по типу, содержащий настройки форматирования.

MB_CUSTOM_GEOJSON

Тип: string
Значение по умолчанию: "{}"

Объект JSON, содержащий информацию о пользовательских файлах GeoJSON для использования в визуализациях карт вместо дефолтных US State или World GeoJSON.

MB_CUSTOM_GEOJSON_ENABLED

Тип: boolean
Значение по умолчанию: true

Включено или нет использование пользовательского GeoJSON.

MB_DB_AUTOMIGRATE

Тип: boolean
Значение по умолчанию: true

Когда установлено значение false, Glarus BI покажет на экране миграции, которые необходимо выполнить в базе данных приложения, после чего завершит работу. Эти миграции нужно будет применить вручную. Когда установлено значение true, Glarus BI будет автоматически выполнять миграции и вносить изменения в базу данных приложения. Примечание: Это не связано с миграцией с H2 на другую БД.

MB_DB_CONNECTION_TIMEOUT_MS

Тип: integer
Значение по умолчанию: 10000

Лимит времени в миллисекундах для подключения к базам данных, как к метаданным Glarus BI, так и к источникам данным. Если вы подключаетесь через SSH-туннель и сталкиваетесь с превышением времени ожидания запроса, то это значение можно увеличить, так как подключения через туннели имеет большую нагрузку, чем подключения без них.

MB_DB_CONNECTION_URI

Тип: string
Значение по умолчанию: null

JDBC подключение, которое может быть использовано вместо переменных окружения MB_DB_*, например, MB_DB_HOST. Также используется, когда требуется задать определённые параметры строки подключения. Требования к типу подключения такие же, как и для переменных окружения MB_DB_TYPE.

Примеры:

jdbc:postgresql://db.example.com:5432/mydb?user=dbuser&password=dbpassword

jdbc:postgresql://db.example.com:5432/mydb?user=dbuser&password=dbpassword&ssl=true&sslfactory=org.postgresql.ssl.NonValidatingFactory

jdbc:mysql://db.example.com:3306/mydb?user=dbuser&password=dbpassword

MB_DB_DBNAME

Тип: string
Значение по умолчанию: null

Имя базы данных для метаданных Glarus BI, находящейся на хосте MB_DB_HOST.

MB_DB_FILE

Тип: string
Значение по умолчанию: "metabase.db"

Расположение файла базы данных H2. Должно не включать в себя .mv.db (или .h2.db). Используется, когда MB_DB_TYPE установлен в "h2". Также может использоваться при миграции с H2 при указании, где именно находится файл данных.

MB_DB_HOST

Тип: string
Значение по умолчанию: null

Имя или IP-адрес хоста базы данных метаданных. Используется, когда MB_DB_TYPE установлен в значение, отличное от "h2".

MB_DB_IN_MEMORY

Тип: boolean
Значение по умолчанию: null

Используется для тестирования вместе с MB_DB_FILE.

MB_DB_PASS

Тип: string
Значение по умолчанию: null

Пароль для MB_DB_HOST.

MB_DB_PORT

Тип: integer
Значение по умолчанию: null

Порт для MB_DB_HOST.

MB_DB_TYPE

Тип: string ("h2", "postgres", "mysql")
Значение по умолчанию: "h2"

Если значение равно "h2", то метаданные загружаются из MB_DB_FILE, иначе при определении сервера метаданных Glarus BI будет использовать MB_DB_HOST.

MB_DB_USER

Тип: string
Значение по умолчанию: null

Имя пользователя для MB_DB_HOST.

MB_DEV_ADDITIONAL_DRIVER_MANIFEST_PATHS

Тип: string
Значение по умолчанию: null

Используется при разработке сторонних плагинов. Установите значение, чтобы манифест-файл данного плагина загрузился во время старта приложения. Можно через запятую указать множественные манифесты для нескольких плагинов.

MB_DISABLE_SESSION_THROTTLE

Тип: boolean
Значение по умолчанию: false

При выставлении значения в true, отключается регулирование количества запросов в рамках одной сессии (throttling). Предупреждение: Не рекомендуется отключать этот механизм, так как это одна из защитных мер против brute force-атак.

Используйте MB_SOURCE_ADDRESS_HEADER для установки IP-адреса удалённого клиента, например, reverse-proxy.

MB_EMAIL_FROM_ADDRESS

Тип: string
Значение по умолчанию: null

Адрес, который вы хотите использовать в качестве отправителя почтовых сообщений, сгенерированных Glarus BI, например, запросов на активацию аккаунта и тд.

MB_EMAIL_FROM_NAME

Тип: string
Значение по умолчанию: null
Начиная с версии: v44.0

Установка имени отправителя в почтовых сообщениях, которые сгенерированы Glarus BI. По умолчанию имя не указано, т.е. будет показан адрес MB_EMAIL_FROM_ADDRESS.

MB_EMAIL_REPLY_TO

Тип: string
Значение по умолчанию: null
Начиная с версии: v44.0

Добавляет Reply-To адрес в почтовые сообщения. Должен соответствовать формату "['address@domain.example']" (включая квадратные скобки).

MB_EMAIL_SMTP_HOST

Тип: string
Значение по умолчанию: null

Адрес почтового SMTP-сервера.

MB_EMAIL_SMTP_PASSWORD

Тип: string
Значение по умолчанию: null

Пароль на SMTP.

MB_EMAIL_SMTP_PORT

Тип: integer
Значение по умолчанию: null

Порт SMTP-сервера исходящей почты.

MB_EMAIL_SMTP_SECURITY

Тип: string ("tls", "ssl", "starttls", "none")
Значение по умолчанию: "none"

Протокол безопасности SMTP.

MB_EMAIL_SMTP_USERNAME

Тип: string
Значение по умолчанию: null

Имя пользователя SMTP.

MB_EMBEDDING_APP_ORIGIN

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

URL источника, которому позволено полное встраивание приложения Glarus BI.

Связан с MB_SESSION_COOKIE_SAMESITE. Больше информации - см. Интерактивное встраивание.

MB_EMBEDDING_SECRET_KEY

Тип: string
Значение по умолчанию: null
Начиная с версии: v44.0

Секретный ключ, используемый для подписания JSON Web-токенов при запросах к методам /api/embed.

Секретный ключ должен храниться в безопасном месте (обращайтесь с ним как с паролем) и рекомендуется, чтобы представлял собой 64-символьную строку.

Этот функционал используется для статического встраивания и не связан с JWT SSO аутентификацией (см. MB_JWT_ENABLED).

MB_EMOJI_IN_LOGS

Тип: boolean
Значение по умолчанию: true

Emojis в журналах логов. false отключает использование emojis. Связано с MB_COLORIZE_LOGS.

MB_ENABLE_EMBEDDING

Тип: boolean
Значение по умолчанию: false

Позволяет администраторам безопасно встраивать запросы или дашборды в другие приложения.

MB_ENABLE_NESTED_QUERIES

Тип: boolean
Значение по умолчанию: true

Позволяет использовать сохранённый запрос как источник других запросов.

MB_ENABLE_PASSWORD_LOGIN

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: true

Разрешает логин по электронной почте и паролю, в том случае если включен SSO-логин.

MB_ENABLE_PUBLIC_SHARING

Тип: boolean
Значение по умолчанию: false

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

MB_ENABLE_QUERY_CACHING

Тип: boolean
Значение по умолчанию: false

Включает кэширование результатов запросов, которые выполняются длительное время.

MB_ENABLE_TEST_ENDPOINTS

Тип: boolean
Значение по умолчанию: null

Если true, то активирует метод /api/testing. Предупреждение: Это должно быть выключено на сервере в промышленной эксплуатации.

MB_ENABLE_XRAYS

Тип: boolean
Значение по умолчанию: true

Позволяет пользователям исследовать данные с помощью результатов «умного анализа».

MB_ENCRYPTION_SECRET_KEY

Тип: string
Значение по умолчанию: null

При установке включает шифрование параметров доступа к базе данных метаданных. Требование: минимум 16 символьная base64-строка.

Смотри также Шифрование соединения с базой данных.

MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN

Тип: string
Значение по умолчанию: null

Когда задано, позволяет пользователям автоматически создавать свою учетную запись Glarus BI, входя в систему, если адрес электронной почты их аккаунта Google принадлежит данному домену.

MB_GOOGLE_AUTH_CLIENT_ID

Тип: string
Значение по умолчанию: null

Идентификатор клиента (Client ID) для единой авторизации Google. Если этот параметр установлен, то считается, что авторизация Google включена.

MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE

Тип: integer
Значение по умолчанию: 15
Начиная с версии: v35.0

Максимальное количество соединений с базами данных источников. Максимум для каждой базы данных, настроенной в Панели администратора > Базы данных, а не общий для всех баз данных. Увеличьте это значение, если вы заметите, что обычное использование занимает все или почти все соединения. Когда все соединения используются, то Glarus BI будет медленнее возвращать результаты для запросов, так как ему придется ждать доступного соединения перед обработкой следующего запроса из очереди.

См. MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE для настройки максимального количества подключений к базе данных приложения Glarus BI.

MB_JETTY_ASYNC_RESPONSE_TIMEOUT

Тип: integer
Значение по умолчанию: 600000
Начиная с версии: v35.0

Время ожидания для асинхронных потоков Jetty, определенное в миллисекундах. По умолчанию равно 10 минутам. Этот таймаут достигается не очень часто, но возможен, например, в случае загрузки CSV-файлов.

MB_JETTY_DAEMON

Тип: boolean
Значение по умолчанию: false

Использование потоков демонов (фоновых потоков)

MB_JETTY_HOST

Тип: string
Значение по умолчанию: localhost for JAR, 0.0.0.0 for Docker

Настройте хост, указав имя хоста или IP-адрес, чтобы идентифицировать сетевой интерфейс, на котором будет открыт порт сервера Jetty. Если установлено в «0.0.0.0», то Glarus BI будет слушать все сетевые интерфейсы на порту, указанном в MB_JETTY_PORT.

MB_JETTY_JOIN

Тип: boolean
Значение по умолчанию: true

Блокировать поток до тех пор, пока сервер не остановит работу.

MB_JETTY_MAXIDLETIME

Тип: integer
Значение по умолчанию: 200000

Максимальное время ожидания подключения в миллисекундах.

MB_JETTY_MAXQUEUED

Тип: integer
Значение по умолчанию: «FIX ME»

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

MB_JETTY_MAXTHREADS

Тип: integer
Значение по умолчанию: 50

Максимальное количество потоков.

Увеличьте это значение, если вы заметите, что обычное использование занимает все или почти все потоки. Когда все потоки используются, Glarus BI может медленно отвечать на запросы.

Чтобы увидеть, сколько потоков используется, проверьте журналы Glarus BI и ищите строки, содержащие следующее: «Jetty threads: 45/50…». В этом случае это означает, что используются 45 из 50 доступных потоков.

Связано с MB_ASYNC_QUERY_THREAD_POOL_SIZE.

MB_JETTY_MINTHREADS

Тип: integer
Значение по умолчанию: 8

Минимальное количество потоков.

MB_JETTY_PORT

Тип: integer
Значение по умолчанию: 3000

Настроить, какой порт использовать для HTTP. Он будет слушать интерфейс, указанный в MB_JETTY_HOST.

MB_JETTY_REQUEST_HEADER_SIZE

Тип: integer
Значение по умолчанию: 8192
Начиная с версии: v36.0

Максимальный размер заголовка в байтах. Увеличьте это значение, если у вас возникают ошибки типа «Размер заголовка запроса превышает допустимые значения».

MB_JETTY_SSL

Тип: boolean
Значение по умолчанию: null

Когда установлено значение true, будет включен HTTPS с опциями, настроенными в переменных MB_JETTY_SSL_*. Также смотрите Настройка веб-сервера Glarus BI Jetty.

MB_JETTY_SSL_CLIENT_AUTH

Тип: boolean
Значение по умолчанию: null

Настроить SSL-аутентификацию клиента Java. Если установлено значение true, сертификаты клиента запрашиваются и проверяются центром сертификации в TrustStore.

MB_JETTY_SSL_KEYSTORE

Тип: string
Значение по умолчанию: null

Путь к файлу Java KeyStore (хранилищу ключей)

MB_JETTY_SSL_KEYSTORE_PASSWORD

Тип: string
Значение по умолчанию: null

Пароль для файла Java KeyStore.

MB_JETTY_SSL_PORT

Тип: integer

Значение по умолчанию: null

Задать, на какой порт направлять HTTPS траффик. Он будет слушать интерфейс, указанный в MB_JETTY_HOST.

MB_JETTY_SSL_TRUSTSTORE

Тип: string
Значение по умолчанию: null

Путь к хранилищу Java TrustStore.

MB_JETTY_SSL_TRUSTSTORE_PASSWORD

Тип: string
Значение по умолчанию: null

Пароль хранилища Java TrustStore.

MB_JWT_ATTRIBUTE_EMAIL

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "email"

Ключ для определения пользовательского почтового адреса.

MB_JWT_ATTRIBUTE_FIRSTNAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "first_name"

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

MB_JWT_ATTRIBUTE_GROUPS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "groups"

Ключ для определения пользовательской группы.

MB_JWT_ATTRIBUTE_LASTNAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "last_name"

Ключ, по которому можно получить имя пользователя JWT-токена.

MB_JWT_ENABLED

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: false

Когда установлено значение true, будет включена аутентификация JWT с настройками, заданными в переменных MB_JWT_*.

Это необходимо для JWT SSO аутентификации, и не имеет отношения к статическому встраиванию, представляющему собой MB_EMBEDDING_SECRET_KEY.

MB_JWT_GROUP_MAPPINGS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "{}"

Объект JSON, содержащий маппинг JWT и групп Glarus BI. Должен быть в формате: '{"groupName": [1, 2, 3]}', где ключи являются группами JWT, а значения являются списком ID групп Glarus BI.

MB_JWT_GROUP_SYNC

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: false

Активизирует синхронизацию групп пользователей с JWT.

MB_JWT_IDENTITY_PROVIDER_URI

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

URL-страницы аутентификации JWT.

MB_JWT_SHARED_SECRET

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

Строка, используемая для запуска закрытого ключа, используемого для проверки сообщений JWT.

MB_LANDING_PAGE

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: ""

Страница по умолчанию, которая показывается при входе в систему.

MB_LDAP_ATTRIBUTE_EMAIL

Тип: string
Значение по умолчанию: "mail"

Настройка, которая указывает Glarus BI, какой атрибут использовать в JWT для идентификации адреса электронной почты пользователя. Обычно это „mail“, „email“ или „userPrincipalName“.

MB_LDAP_ATTRIBUTE_FIRSTNAME

Тип: string
Значение по умолчанию: "givenName"

Параметр, используемый для имени пользователя. Обычно „givenName“ (имя).

MB_LDAP_ATTRIBUTE_LASTNAME

Тип: string
Значение по умолчанию: "sn"

Параметр, используемый для фамилии пользователя. Обычно „sn“

MB_LDAP_BIND_DN

Тип: string
Значение по умолчанию: null

Выделенное имя, к которому нужно привязаться (если оно присутствует). Пользователь, зарегистрированный под этим именем, будет использоваться для поиска информации о других пользователях.

MB_LDAP_ENABLED

Тип: boolean
Значение по умолчанию: false

Когда установлено значение true, будет включена аутентификация LDAP с опциями, настроенными в переменных MB_LDAP_*.

MB_LDAP_GROUP_BASE

Тип: string
Значение по умолчанию: null

База поиска для LDAP-групп. Не требуется, если ваш каталог LDAP предоставляет «memberOf» overlay-диалог. (Сам поиск при этом происходит рекурсивно).

MB_LDAP_GROUP_MAPPINGS

Тип: string
Значение по умолчанию: "{}"

Объект JSON, содержащий сопоставление групп LDAP и Glarus BI.

MB_LDAP_GROUP_MEMBERSHIP_FILTER

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "(member={dn})"
Начиная с версии: v40.0

Фильтр поиска пользователя в группе. Переменные {dn} и {uid} должны быть заменены выделенным именем пользователя и его UID соответственно.

MB_LDAP_GROUP_SYNC

Тип: boolean
Значение по умолчанию: false

Включает синхронизацию групп с LDAP.

MB_LDAP_HOST

Тип: string
Значение по умолчанию: null

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

MB_LDAP_PASSWORD

Тип: string
Значение по умолчанию: null

Пароль для привязки пользователя.

MB_LDAP_PORT

Тип: string
Значение по умолчанию: "389"

Порт сервера, обычно 389 или 636, если используется SSL.

MB_LDAP_SECURITY

Тип: string ("none", "ssl", "starttls")
Значение по умолчанию: "none"

Используйте SSL, TLS или обычный текст.

MB_LDAP_SYNC_USER_ATTRIBUTES

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: true

Синхронизируйте атрибуты пользователя при логине через LDAP.

MB_LDAP_SYNC_USER_ATTRIBUTES_BLACKLIST

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "userPassword,dn,distinguishedName"

Разделённый запятыми список пользовательских атрибутов, для которых синхронизация LDAP должна быть пропущена.

MB_LDAP_USER_BASE

Тип: string
Значение по умолчанию: null

База поиска пользователей. (Сам поиск будет происходит рекурсивно).

MB_LDAP_USER_FILTER

Тип: string
Значение по умолчанию: "(&(objectClass=inetOrgPerson)(|(uid={login})(mail={login})))"

Фильтр поиска пользователей. Параметр {login} будет заменён логином, предоставленным пользователем.

MB_LOADING_MESSAGE

Доступна лишь на некоторых планах
Тип: string ("doing-science", "running-query", "loading-results")
Значение по умолчанию: "doing-science."
Начиная с версии: v44.0

Измените сообщение, которое будет показано на экране во время загрузки данных.

MB_MAP_TILE_SERVER_URL

Тип: string
Значение по умолчанию: "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png"

Шаблон URL сервера, используемый в визуализации карт, например, OpenStreetMaps или MapBox.

MB_NATIVE_QUERY_AUTOCOMPLETE_MATCH_STYLE

Тип: string ("substring", "prefix", "off")
Значение по умолчанию: "substring"
Начиная с версии: v44.1

Соответствующий стиль для автозаполнения встроенного редактора запросов. В крупных экземплярах возможны проблемы с производительностью при использовании шаблона substring, поэтому можно использовать шаблон prefix или выключить автозаполнение (off).

MB_NOTIFICATION_RETRY_INITIAL_INTERVAL

Тип: integer
Значение по умолчанию: 500
Начиная с версии: v44.0

Начальный интервал в миллисекундах для повторной отправки сообщений.

MB_NOTIFICATION_RETRY_MAX_ATTEMPTS

Тип: integer
Значение по умолчанию: 7
Начиная с версии: v44.0

Максимальное количество попыток для доставка одного сообщения.

MB_NOTIFICATION_RETRY_MAX_INTERVAL_MILLIS

Тип: integer
Значение по умолчанию: 30000
Начиная с версии: v44.0

Максимальная задержка между попытками повторной отправки сообщений.

MB_NOTIFICATION_RETRY_MULTIPLIER

Тип: double
Значение по умолчанию: 2.0
Начиная с версии: v44.0

Мультипликатор для задержки перед повторной попыткой отправки одного сообщения.

MB_NOTIFICATION_RETRY_RANDOMIZATION_FACTOR

Тип: double
Значение по умолчанию: 0.1
Начиная с версии: v44.0

Фактор рандомизации для повторной попытки отправки сообщений.

MB_NS_TRACE

Тип: string
Значение по умолчанию: ""

Пространства имён для трассировки, разделенные запятыми. Предупреждение: Может отправлять в журнал логов конфиденциальную информацию, например, пароли к БД.

MB_PASSWORD_COMPLEXITY

Тип: string ("weak", "normal", "strong")
Значение по умолчанию: "normal"

Задание требований на сложность пароля для повышения безопасности аутентификации.

Применимо только для новых пользователей или пользователей, которые меняют свой пароль. Связано с MB_PASSWORD_LENGTH

  • weak нет ограничений на символы;

  • normal по крайней мере 1 цифра;

  • strong минимум 8 символов с 2 символами нижнего регистра, 2 символами верхнего регистра, 1 цифрой и 1 специальным символом.

MB_PASSWORD_LENGTH

Тип: integer
Значение по умолчанию: 6

Устанавливает минимальную длину пароля для повышения уровня безопасности.

Применимо только для новых пользователей или пользователей, которые меняют свой пароль. По умолчанию (если не задано) используется длина MB_PASSWORD_COMPLEXITY.

MB_PERSISTED_MODEL_REFRESH_CRON_SCHEDULE

Тип: string
Значение по умолчанию: "0 0 0/6 * * ? *"
Начиная с версии: v44.0

Cron-строка для планированя обновления модулей.

MB_PERSISTED_MODELS_ENABLED

Тип: boolean
Значение по умолчанию: false
Начиная с версии: v44.0

Разрешает сохранение моделей в базу данных источника.

MB_PLUGINS_DIR

Тип: string
Значение по умолчанию: "plugins"

Путь к директории «plugins», которая используется для хранения драйверов базы данных Glarus BI. Пользователь, запускающий Glarus BI, должен иметь разрешение на запись в каталог. При запуске JAR-файла директория по умолчанию - plugins, созданная в том же месте, что и файл JAR. При запуске Docker директория по умолчанию - /plugins.

Также это место для добавления сторонних драйверов. В этом случае Glarus BI загрузит драйвер при запуске, информация об этом появится в журнале.

MB_PREMIUM_EMBEDDING_TOKEN

Тип: string
Значение по умолчанию: null

Токен лицензии, используемый для Pro и Enterprise версий, используемый для включения премиум-функций в Enterprise edition Metabase. Он также используется для устаревшей функциональности «Premium Embedding» в Metabase OSS edition.

MB_QP_CACHE_BACKEND

Тип: string
Значение по умолчанию: "db"

Текущее хранение кэша. Динамически перепривязываемый, используется в основном для целей тестирования.

MB_QUERY_CACHING_MAX_KB

Тип: integer
Значение по умолчанию: 1000

Максимальный объем кэша в килобайтах на каждый сохранённый запрос.

MB_QUERY_CACHING_MAX_TTL

Тип: integer
Значение по умолчанию: 8640000

Абсолютный максимум времени для хранения кэшированных запросов (в секундах). Значение по умолчанию: 100 дней в секундах.

MB_QUERY_CACHING_MIN_TTL

Тип: integer
Значение по умолчанию: 60

Glarus BI поместит в кэш все сохранённые запросы, которые исполняются дольше, чем время, указанное в данном параметре.

MB_QUERY_CACHING_TTL_RATIO

Тип: integer
Значение по умолчанию: 10

Чтобы определить, как долго будет сохраняться кэшированный результат каждого сохраненного запроса, мы берём среднее время выполнения запроса и умножаем его на значение данного параметра. Таким образом, если запрос занимает в среднем 2 минуты, а вы вводите значение множителя 10, то запись кэша будет сохраняться в течение 20 минут.

MB_REDIRECT_ALL_REQUESTS_TO_HTTPS

Тип: boolean
Значение по умолчанию: false
Начиная с версии: v36.0

Принудительно перенаправляет весь траффик на HTTPS, в том случае если URL сайта HTTPS. Связано с MB_SITE_URL

MB_REPORT_TIMEZONE

Тип: string
Значение по умолчанию: null

Часовой пояс, используемый при выполнении запросов. По умолчанию соответствует системному часовому поясу.

MB_SAML_APPLICATION_NAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "Glarus BI"

Имя приложения, которое будет использовано для запросов к Идентификационному поставщику (IdP).

MB_SAML_ATTRIBUTE_EMAIL

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress"

SAML-параметр для пользовательского адреса электронной почты.

MB_SAML_ATTRIBUTE_FIRSTNAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname"

SAML-параметр для имени пользователя.

MB_SAML_ATTRIBUTE_GROUP

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "member_of"

SAML-параметр для синхронизации групп.

MB_SAML_ATTRIBUTE_LASTNAME

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"

SAML-параметр для фамилии пользователя.

MB_SAML_ENABLED

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: false

Когда установлено в true, включает аутентификацию SAML с опциями, настроенными в переменных MB_SAML_*.

MB_SAML_GROUP_MAPPINGS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "{}"

Объект JSON, содержащий соответствия групп SAML и Glarus BI. Должен быть в форме: '{"groupName": [1, 2, 3]}', где ключи - это группы SAML, а значения - это списки ID групп Glarus BI.

MB_SAML_GROUP_SYNC

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: false

Активирует синхронизацию с группами через SAML.

MB_SAML_IDENTITY_PROVIDER_CERTIFICATE

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

Зашифрованный сертификат для Идентификационного поставщика (IdP), представленный в виде содержимого, а не пути к файлу.

MB_SAML_IDENTITY_PROVIDER_ISSUER

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

Это уникальный идентификатор для Идентификационного поставщика (IdP). Часто называется Entity ID или Issuer. В зависимости от вашего IdP, он обычно выглядит как http://www.example.com/141xkex604w0Q5PN724v

MB_SAML_IDENTITY_PROVIDER_URI

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

Это URL для логина пользователей вашего Идентификационного поставщика (IdP). В зависимости от того, какой идентификатор поставщика вы используете, это обычно выглядит как https://your-org-name.okta.com.

MB_SAML_KEYSTORE_ALIAS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "metabase"

Псевдоним для ключа, который Glarus BI должен использовать для подписи запросов SAML.

MB_SAML_KEYSTORE_PASSWORD

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: "changeit"

Пароль для KeyStore.

MB_SAML_KEYSTORE_PATH

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null

Абсолютный путь к файлу KeyStore, который используется для подписи запросов SAML.

MB_SEARCH_TYPEAHEAD_ENABLED

Тип: boolean
Значение по умолчанию: true
Начиная с версии: v39.0

Показывать автоподстановки при использовании глобального поиска в верхней панели навигации.

MB_SEND_EMAIL_ON_FIRST_LOGIN_FROM_NEW_DEVICE

Тип: boolean
Значение по умолчанию: true
Начиная с версии: v39.0

Отправлять уведомления по электронной почте пользователю, когда он входит с нового устройства. Установите значение false, чтобы прекратить отправку электронных писем «Мы заметили новый вход в вашу учётную запись Glarus BI» для всех пользователей.

Также эта переменная контролирует сервис геокодирования, который использует Glarus BI, чтобы знать местоположение, из которого ваши пользователи вошли. Установка этой переменной в false также отключает эту функцию обратного геокодирования.

MB_SEND_NEW_SSO_USER_ADMIN_EMAIL

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: true

Отправляет уведомления на email всем пользователям, включённым в группу администраторов при создании новых SSO-пользователей.

MB_SESSION_COOKIES

Тип: boolean
Значение по умолчанию: null

Когда установлено в «true», сеанс входа пользователя будет инвалидирован при закрытии браузера. Сеанс входа пользователя всегда истекает после времени, определённого в MAX_SESSION_AGE (по умолчанию 2 недели).

Это переопределяет флажок «Запомнить меня» при входе.

См. также Срок действия сеанса.

MB_SESSION_TIMEOUT

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null
Начиная с версии: v44.0

Время до выхода из системы неактивных пользователей. По умолчанию время жизни сессии выставляется согласно параметрам MAX_SESSION_AGE и MB_SESSION_COOKIES.

Должен быть в формате "{:amount 60 :unit 'minutes'}", где единица измерения может быть «seconds», «minutes» или «hours».

MB_SETUP_TOKEN

Тип: string
Значение по умолчанию: null

UUID-токен, используемый для верификации того факта, что экземпляр приложения обладает достаточными правами для создания начального пользователя. Исполняется при первом запуске Glarus BI первым экземпляром приложения, после чего информация удаляется и никогда после этого не используется.

MB_SHOW_DATABASE_SYNCING_MODAL

Тип: boolean
Значение по умолчанию: null

Указывает, показывать ли модальное окно приветствия после добавления следующего подключения к базе данных. По умолчанию равно false, если любая база данных, отличная от базы данных по умолчанию, уже завершила синхронизацию для этого экземпляра.

MB_SHOW_HOMEPAGE_DATA

Тип: boolean
Значение по умолчанию: null

Скрывает секции «Наши данные» с показа на заглавной страницы, будучи установлен в false. Секция показывается, если значение true.

MB_SHOW_HOMEPAGE_XRAYS

Тип: boolean
Значение по умолчанию: null

Чтобы скрыть раздел «Умный анализ» с главной страницы, установите значение в false. Чтобы показать раздел, если он был вручную удален, установите значение в true. Даже если значение установлено в true, раздел будет скрыт, если какие-либо дашборды были закреплены в коллекции «Наша аналитика».

MB_SHOW_LIGHTHOUSE_ILLUSTRATION

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: true
Начиная с версии: v44.0

Отображение лого на домашней странице и странице логина.

MB_SHOW_METABOT

Доступна лишь на некоторых планах
Тип: boolean
Значение по умолчанию: true
Начиная с версии: v44.0

Показать символ Metabot на заглавной странице.

MB_SITE_LOCALE

Тип: string
Значение по умолчанию: "en"

Язык по умолчанию для этого экземпляра Glarus BI. Это касается только интерфейса Glarus BI, электронной почты, подписей диаграмм и оповещений. Язык по умолчанию можно изменить в настройках пользователя.

MB_SITE_NAME

Тип: string
Значение по умолчанию: "Glarus BI"

Название по умолчанию для данного экземпляра Glarus BI.

MB_SITE_URL

Тип: string
Значение по умолчанию: null

Основной URL, по которому пользователи получают доступ к Glarus BI, например, https://metabase.example.com или https://example.com/metabase.

Этот URL критичен для, таких вещей, как SSO-аутентификация, ссылки на электронную почту, встраивание и т.д. Даже разница http:// вместо https:// может вызвать проблемы. Убедитесь, что адрес URL соответствует тому, по которому осуществляется доступ к Glarus BI.

MB_SLACK_APP_TOKEN

Тип: string
Значение по умолчанию: null
Начиная с версии: v42.0

Токен для Slack API, полученный из Using the Slack Web API | Slack. В версиях до v42.0 использовалась переменная MB_SLACK_TOKEN, но теперь она устарела и больше не должна использоваться.

MB_SLACK_FILES_CHANNEL

Тип: string
Значение по умолчанию: "metabase_files"
Начиная с версии: v42.0

Установить Slack-канал системных файлов, который использует Glarus BI для хранения изображений. Этот канал должен быть открытым и не предназначен для использования пользователями. Приложение Slack должно быть приглашено в этот канал.

MB_SOURCE_ADDRESS_HEADER

Тип: string
Значение по умолчанию: X-Forwarded-For

Указывает источник HTTP-запросов по значению этого заголовка, а не по удалённому адресу. Связано с MB_DISABLE_SESSION_THROTTLE.

MB_SQL_JDBC_FETCH_SIZE

Тип: integer
Значение по умолчанию: 500
Начиная с версии: v41.1

Установленный размер выборки. Необходимо обеспечить, чтобы объекты JDBC ResultSet не хранили все результаты в памяти. Эта настройка применима только к некоторым базам данных. Установка этого параметра слишком большим значением может вызвать ошибку OutOfMemory, установка его слишком низким значением может вызвать проблемы с производительностью.

MB_SSH_HEARTBEAT_INTERVAL_SEC

Тип: integer
Значение по умолчанию: 180

Определяет, как часто идет нотификация после установления SSH-туннеля (в секундах).

MB_SSL_CERTIFICATE_PUBLIC_KEY

Тип: string
Значение по умолчанию: null

Публичный ключ формата Base64 для SSL-сертификата этого сайта. Установите значение этого параметра, чтобы включить HTTP Public Key Pinning. Использование HPKP больше не рекомендуется. См. Http://mzl.la/1EnfqBf для получения дополнительной информации.

MB_START_OF_WEEK

Тип: string
Значение по умолчанию: "sunday"
Начиная с версии: v37.0

Это влияет на такие вещи, как группировка по неделям или, например, фильтрация в запросах GUI. Этот параметр не оказывает влияния на большинство других SQL-запросов, хотя он и используется для установки переменной сессии WEEK_START в Snowflake.

MB_SUBSCRIPTION_ALLOWED_DOMAINS

Доступна лишь на некоторых планах
Тип: string
Значение по умолчанию: null
Начиная с версии: v41.0

Разрешенные домены электронной почты для новых подписок и оповещений. Укажите несколько доменов через запятую. Если параметр не указан, то будут разрешены все домены.

MB_UNAGGREGATED_QUERY_ROW_LIMIT

Тип: integer
Значение по умолчанию: 2000

Максимальное количество строк, возвращаемых по запросам типа :rows через API. Должно быть меньше 1048575 и меньше числа, указанного в MB_AGGREGATED_QUERY_ROW_LIMIT. Эта переменная среды также определяет количество строк, возвращаемых Glarus BI во вложениях подписки на дашборды.

См. также MB_AGGREGATED_QUERY_ROW_LIMIT.