环境变量

Metabase的许多设置都可以在管理面板中查看和修改，或通过环境变量进行设置。
环境变量优先级最高。

配置方式

设置环境变量可以通过多种方式完成，具体取决于Metabase的运行方式。

通过jar包直接运行：

# Mac, Linux and other Unix-based systems
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 metabase.jar

或者将其设置为 Java 属性，该属性在所有系统中的工作方式相同：

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

通过docker运行：

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

环境变量列表

MAX_SESSION_AGE

• 类型：int

• 默认值：20160

  session过期时间，单位为分钟（默认值为20160，对应2周）。在session过期后会注销用户，并要求重新进行登录
  注意：这个环境变量不是空闲或不活动的超时配置。如果将其设置为 15 分钟，则用户必须每隔 15 分钟再次登录（或重新进行身份验证）。用MB_SESSION_TIMEOUT来做根据不活动状态超时控制。用MB_SESSION_COOKIES配置浏览器关闭的情况下是否超时。

MB_ADMIN_EMAIL

• 类型：string

• 默认值：null

  如果用户遇到问题，可以向此邮件地址发送详细问题。

MB_ANON_TRACKING_ENABLED

• 类型：bool

• 默认值：true

  启用匿名数据采集，帮助metabase完善产品

MB_API_KEY

• 类型：string

• 默认值：null

  通过请求头强制验证客户端的中间件。如果请求头可用，则对其进行验证。当匹配时，请求继续;否则，将响应403。请求头格式X-Metabase-Apikey:MB_API_KEY

MB_APPLICATION_COLORS (商业版支持)

• 类型：string

• 默认值："{}"

  json对象，里面设置图表和整个metabase使用的主色调。

MB_APPLICATION_DB_MAX_CONNECTION_POOL_SIZE(从v0.35版本开始支持)

• 类型：int

• 默认值：

  metabase自生数据库的最大连接数
  如果管理员注意到在一般情况下数据库的连接数都会被占满，需要将它配置的更大。因为所有数据库连接都在使用中时，再单击界面时，Metabase 可能会让用户感觉很慢或无响应。
  若要查看正在使用的连接数，请检查metabase日志。例如，日志中显示"… App DB connections: 12/15 …… ",则代表总共有15个连接，已经使用了12个。
  另外数据源连接到metabase的最大连接数请配置MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE这个环境变量。

MB_APPLICATION_FAVICON_URL(商业版支持)

• 类型：string

• 默认值："frontend_client/favicon.ico"

  自定义metabase的应用图标

MB_APPLICATION_FONT(商业版支持)

• 类型：字符串

• 默认值："Lato"

  自定义metabase的字体

MB_APPLICATION_FONT_FILES(商业版支持)

• 类型：string

• 默认值："{}"

  告诉metabase将哪些字体文件用于不同的样式。示例值：

[
  {
     "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"

  修改metabase logo。建议使用 SVG 格式。

MB_APPLICATION_NAME(商业版支持)

• 类型：string

• 默认值："Metabase"

  将Metabase替换为定义的字符串，例如用户公司的名称。

MB_ASYNC_QUERY_THREAD_POOL_SIZE(从v0.35开始支持)

• 类型：int

• 默认值：50

  Jetty的异步线程最大数。如果未设置，则使用MB_JETTY_MAXTHREADS。

MB_BREAKOUT_BIN_WIDTH

• 类型：double

• 默认：10.0

  当对坐标类型的字段（例如纬度和经度）使用默认分组策略时，此数字将用作默认分组宽度（以度为单位）。

MB_BREAKOUT_BINS_NUM

• 类型：int

• 默认值：8

  当使用默认分组策略且未提供多个分组时，此数字将用作默认值。

MB_CHECK_FOR_UPDATES

• 类型：bool

• 默认值：true

  检查metabase是否有新版发布。

MB_COLORIZE_LOGS

• 类型：bool

• 默认值：true

  以不同颜色显示日志（方便区分日志等级和关键字）。设置为false日志字体将只显示一种颜色。在windows上这个配置不生效。相关的环境变量：MB_EMOJI_IN_LOGS.

MB_CUSTOM_FORMATTING

• 类型：string

• 默认值："{}"

  值为json对象，它包含格式化的配置

MB_CUSTOM_GEOJSON

• 类型：string

• 默认值："{}"

  值为json对象，包含有关自定义 GeoJSON 文件的信息。在新版本用户可以自己在后台添加自定义的geojson地图，而不是通过这个配置。

MB_CUSTOM_GEOJSON_ENABLED

• 类型：bool

• 默认值：true

  是否启用了自定义 GeoJSON

MB_DB_AUTOMIGRATE

• 类型：bool
• 默认值：true

当设置为 false 时，Metabase 将打印需要在应用程序数据库中完成的迁移并退出，这些迁移需要手动应用。当为 true 时，Metabase 将自动对应用程序数据库进行更改。 这个配置与从 H2 迁移无关。

MB_DB_CONNECTION_TIMEOUT_MS

• 类型：int

• 默认值：5000

  数据库连接超时时间，单位为ms

MB_DB_CONNECTION_URI

• 类型：string

• 默认值：null

  一个 JDBC 样式的连接写法，可用于代替以下环境变量MB_DB_TYPE MB_DB_HOST MB_DB_UESR等.

#eg:
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

  指定metabase应用数据库的数据库名称，与MB_DB_HOST等搭配使用。

MB_DB_FILE

• 类型：string

• 默认值："metabase.db"

  指定H2数据库的名称

MB_DB_HOST

• 类型：string

• 默认值：null

  metabase应用数据库的主机名或 IP 地址。

MB_DB_IN_MEMORY

• 类型：bool

• 默认值：null

  用于测试MB_DB_FILE.

MB_DB_PASS

• 类型：string

• 默认值：null

  metabase应用数据库的密码，与MB_DB_USER等搭配使用

MB_DB_PORT

• 类型：整数

• 默认值：null

  metabase应用数据库的端口

MB_DB_TYPE

• 类型：string

• 默认值："h2"

  metabase应用数据库的类型，支持"postgres""mysql""h2"

MB_DB_USER

• 类型：string

• 默认值：null

  metabase应用数据库的用户名

MB_DEV_ADDITIONAL_DRIVER_MANIFEST_PATHS

• 类型：string

• 默认值：null

  在开发第三方数据源驱动程序期间使用。设置它使该插件在启动期间加载。通过逗号分隔来指定多个插件。

MB_DISABLE_SESSION_THROTTLE

• 类型：bool

• 默认值：false

  任何时候，这个配置都将禁用会话限制。
  警告：不建议禁用限制，因为它是防止暴力攻击的保护措施。

用MB_SOURCE_ADDRESS_HEADER从反向代理设置远程客户端的 IP 地址。

MB_EMAIL_FROM_ADDRESS

• 类型：string

• 默认值：null

  用作metabase生成的电子邮件（例如slack或帐户邀请）的发件人的地址。

MB_EMAIL_FROM_NAME(从v0.44开始支持)

• 类型：string

• 默认值：null

  在电子邮件中使用定义的名称。默认情况下，不使用任何名称，这意味着它只显示MB_EMAIL_FROM_ADDRESS的电子邮件地址。

MB_EMAIL_REPLY_TO

• 类型：string

• 默认值：null

  在电子邮件中包含回复地址。格式必须为以下这种方式（包括方括号）。"['address@domain.example']"

MB_EMAIL_SMTP_HOST

• 类型：string

• 默认值：null

  处理电子邮件的 SMTP 服务器的地址。

MB_EMAIL_SMTP_PASSWORD

• 类型：string

• 默认值：null

  发件邮箱的密码。

MB_EMAIL_SMTP_PORT

• 类型：int

• 默认值：null

  SMTP 服务器端口。

MB_EMAIL_SMTP_SECURITY

• 类型：string

• 默认值："none"

  smtp 服务器安全连接协议，值支持"tls""ssl""starttls""none"

MB_EMAIL_SMTP_USERNAME

• 类型：string

• 默认值：null

  发件邮箱用户名（国内一般为发件邮箱地址）。

MB_EMBEDDING_APP_ORIGIN(商业版支持)

• 类型：string

• 默认值：null

  允许将metabase完整嵌入的页面地址

MB_EMBEDDING_SECRET_KEY(从v0.44开始支持)

• 类型：string

• 默认值：null

  /api/embed api的生成jwt token加密密钥。与 jwt sso 无关，这个是metabase自生的。

MB_EMOJI_IN_LOGS

• 类型：bool

• 默认值：true

  日志中支持显示emoji表情。windows环境不支持此配置。相关环境变量MB_COLORIZE_LOGS.

MB_ENABLE_EMBEDDING

• 类型：bool

• 默认值：false

  允许管理员在其他应用程序中安全地嵌入问题和仪表板。

MB_ENABLE_NESTED_QUERIES

• 类型：bool

• 默认值：true

  允许使用保存的问题作为其他查询的来源。

MB_ENABLE_PASSWORD_LOGIN(商业版支持)

• 类型：布尔值

• 默认值：true

  启用 SSO 登录选项后，仍允许通过电子邮件和密码登录。

MB_ENABLE_PUBLIC_SHARING

• 类型：bool

• 默认值：false

  允许为问题和仪表板创建分享链接（和嵌入式 iframe）。

MB_ENABLE_QUERY_CACHING

• 类型：bool

• 默认值：false

  启用缓存将保存查询耗时比较长的查询的结果。

MB_ENABLE_TEST_ENDPOINTS

• 类型：bool

• 默认值：null

  当值为true的时候将启用/api/testing这个api
  警告：这永远不应该在生产系统中启用。

MB_ENABLE_XRAYS

• 类型：bool

• 默认值：true

  允许用户使用 X 射线浏览数据。

MB_ENCRYPTION_SECRET_KEY

• 类型：string

• 默认值：null

  设置后，这将加密存储在应用程序数据库中的凭据(例如，数据源的账号密码) 要求：至少 16 个字符 base64 编码的字符串。

MB_GOOGLE_AUTH_AUTO_CREATE_ACCOUNTS_DOMAIN

• 类型：string

• 默认值：null

  设置后，如果用户的 Google 帐户电子邮件地址来自此域，则允许用户通过登录自动创建其metabase帐户。

MB_GOOGLE_AUTH_CLIENT_ID

• 类型：string

• 默认值：null

  Google Auth SSO 的客户端 ID。如果设置了此设置，则认为谷歌身份验证已启用。

MB_JDBC_DATA_WAREHOUSE_MAX_CONNECTION_POOL_SIZE(自v0.35开始启用)

• 类型：int

• 默认值：15

  metabase与数据源数据库的最大连接数。最大值是在管理面板-->数据库中的每个数据库设置，而不是所有数据库的总数。
  如果管理员注意到一般情况下此值都会被占满，请将此值更改为更高的值。当所有连接都在使用中时，metabase返回查询结果的速度会变慢，因为它必须等待可用连接才能处理队列中的下一个查询。

MB_JETTY_ASYNC_RESPONSE_TIMEOUT(自v0.35开始启用)

• 类型：int

• 默认值：600000

  Jetty 异步线程超时时间，单位为ms。默认值为 10 分钟。很少有可能达到超时，因为它们之前会返回某种类型的数据，但像 CSV 等下载这样的操作可能会。

MB_JETTY_DAEMON

• 类型：bool

• 默认值：false

  使用守护程序线程。

MB_JETTY_HOST

• 类型：string
• 默认：对于JAR为'localhost'，对于Docker为'0.0.0.0'
  配置Jetty的监听地址

MB_JETTY_JOIN

• 类型：bool
• 默认值：true

MB_JETTY_MAXIDLETIME

• 类型：int

• 默认值：200000

  连接最长空闲时间（单位ms）。

MB_JETTY_MAXQUEUED

• 类型：int

• 默认值："FIX ME"

  所有线程都繁忙时要排队的最大请求数。

MB_JETTY_MAXTHREADS

• 类型：int

• 默认值：50

  最大线程数。
  如果您注意到常规使用消耗所有或接近所有线程，请将此值更改为更高的值。当所有线程都在使用中时，在界面周围单击时，metabase可能会让用户感觉很慢或无响应。
  若要查看正在使用的线程数，请检查元数据库日志并查找包含以下内容的行："… Jetty threads: 45/50 …"。在本例中，它指的是共有50个线程，正在使用45个。

MB_JETTY_MINTHREADS

• 类型：int

• 默认值：8

  最小线程数。

MB_JETTY_PORT

• 类型：int

• 默认值：3000

  配置Jetty的监听端口，即metabase的访问端口

MB_JETTY_REQUEST_HEADER_SIZE(从v0.36开始支持)

• 类型：int

• 默认值：8196

  请求头的最大大小（以byte为单位）。如果遇到“请求标头字段太大”等错误，请增加此值。

MB_JETTY_SSL

• 类型：bool

• 默认值：null

  设置为true时，Jetty启用https。相关环境变量 MB_JETTY_SSL_*。

MB_JETTY_SSL_CLIENT_AUTH

• 类型：bool

• 默认值：null

  配置 Java SSL 客户机认证。设置为true时，客户端证书是必需的，并由信任库中的证书颁发机构进行验证。

MB_JETTY_SSL_KEYSTORE

• 类型：string

• 默认值：null

  Java TrustStore 文件的路径。

MB_JETTY_SSL_KEYSTORE_PASSWORD

• 类型：string

• 默认值：null

  Java TrustStore 文件的密码。

MB_JETTY_SSL_PORT

• 类型：int

• 默认值：null

  配置用于 HTTPS 的端口。

MB_JETTY_SSL_TRUSTSTORE

• 类型：string

• 默认值：null

  Java TrustStore 文件的路径。

MB_JETTY_SSL_TRUSTSTORE_PASSWORD

• 类型：string

• 默认值：null

  Java TrustStore 文件的密码。

MB_JWT_ATTRIBUTE_EMAIL(商业版支持)

• 类型：string

• 默认值："email"

  JWT信息里电子邮件地址对应的key。

MB_JWT_ATTRIBUTE_FIRSTNAME(商业版支持)

• 类型：string

• 默认值："first_name"

  JWT信息里 first name 对应的key。

MB_JWT_ATTRIBUTE_GROUPS(商业版支持)

• 类型：string

• 默认值："groups"

  JWT信息里 group 对应的key。

MB_JWT_ATTRIBUTE_LASTNAME(商业版支持)

• 类型：string

• 默认值："last_name"

  JWT信息里 group 对应的key。

MB_JWT_ENABLED(商业版支持)

• 类型：bool

• 默认值：false

  设置为true时,将启用jwt认证。相关环境变量 MB_JWT_*

MB_JWT_GROUP_MAPPINGS(商业版支持)

• 类型：字符串

• 默认值："{}"

  JWT里group值与metabase group值的映射关系。应采用以下格式：其中键是 JWT group，值是metabase group ID 的列表。'{"groupName": [1, 2, 3]}'

MB_JWT_GROUP_SYNC(商业版支持)

• 类型：bool

• 默认值：false

  启用与 JWT 认证的gruop信息同步。

MB_JWT_IDENTITY_PROVIDER_URI(商业版支持)

• 类型：string

• 默认值：null

  基于 JWT 的登录页面的 URL。

MB_JWT_SHARED_SECRET(商业版支持)

• 类型：string

• 默认值：null

  为用于验证 JWT 消息的私钥设定种子的字符串。

MB_LANDING_PAGE(商业版支持)

• 类型：string

• 默认值：""

  自定义登录页

MB_LDAP_ATTRIBUTE_EMAIL

• 类型：string

• 默认值："mail"

  用于用户电子邮件的属性。

MB_LDAP_ATTRIBUTE_FIRSTNAME

• 类型：string

• 默认值："givenName"

  用于用户名字的属性。

MB_LDAP_ATTRIBUTE_LASTNAME

• 类型：string

• 默认值："sn"

  用于用户姓氏的属性。

MB_LDAP_BIND_DN

• 类型：string

• 默认值：null

  要绑定的LDAP DN。

MB_LDAP_ENABLED

• 类型：bool

• 默认值：false

  是否开启LDAP认证

MB_LDAP_GROUP_BASE

• 类型：string

• 默认值：null

  group的搜索库。如果LDAP目录提供"成员"覆盖，则不需要。（将以递归方式搜索。）

MB_LDAP_GROUP_MAPPINGS

• 类型：string

• 默认值："{}"

  LDAP与metabase group映射，值为json对象

MB_LDAP_GROUP_MEMBERSHIP_FILTER(商业版支持)

• 类型：字符串

• 默认值："(member={dn})"

  group成员身份查找筛选器。占位符{dn}，{uid}将分别替换为用户的可分辨名称和 UID。

MB_LDAP_GROUP_SYNC

• 类型：bool

• 默认值：false

  启用与 LDAP 的group成员身份同步。

MB_LDAP_HOST

• 类型：string

• 默认值：null

  LDAP服务器主机域名或ip。

MB_LDAP_PASSWORD

• 类型：string

• 默认值：null

  查找用户要绑定的密码。

MB_LDAP_PORT

• 类型：string

• 默认值："389"

  LDAP端口，如果使用 SSL，则通常为 389 或 636。

MB_LDAP_SECURITY

• 类型：string

• 默认值："none"

  LDAP是否使用加密，支持ssl，starttls，none选项

MB_LDAP_SYNC_USER_ATTRIBUTES(商业版支持)

• 类型：bool

• 默认值：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

• 默认值：''

  在等待数据加载时更改加载消息。

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"

  sql query 自动补全模式。支持三种substring，prefix，off。在大型实例中使用substring模式可能有性能问题，可以调整成prefix，或者直接off关掉

MB_NOTIFICATION_LINK_BASE_URL(商业版支持)

• 类型：string

• 默认值：null

  仪表板通知链接将指向的base URL，而不是metabase 的 base URL。仅适用于使用 FullApp 嵌入和订阅的用户。

MB_NOTIFICATION_RETRY_INITIAL_INTERVAL

• 类型：int

• 默认值：500

  发送通知时的初始重试间隔时间（以毫秒为单位）。

MB_NOTIFICATION_RETRY_MAX_ATTEMPTS

• 类型：int

• 默认值：7

  发送单个通知的最大重试次数。

MB_NOTIFICATION_RETRY_MAX_INTERVAL_MILLIS

• 类型：int

• 默认值：30000

  尝试发送单个通知之间的最大时间间隔。

MB_NOTIFICATION_RETRY_MULTIPLIER

• 类型：double
• 默认：2.0
  尝试发送单个通知之间的间隔乘数。

MB_NOTIFICATION_RETRY_RANDOMIZATION_FACTOR

• 类型：double
• 默认：0.1
  发送通知时重试间隔的随机化因子。

MB_NS_TRACE

• 类型：string

• 默认值：""

  要跟踪的命名空间，以逗号分隔。注意：可以记录数据库密码等敏感信息。

MB_PASSWORD_COMPLEXITY

• 类型：string

• 默认值："normal"

  强制实施密码复杂性规则以提高常规登录的安全性。这仅适用于新用户或正在更改密码的用户，支持选项"weak"，"normal"，"strong"。相关环境变量MB_PASSWORD_LENGTH
  weak：无字符约束
  normal：至少 1 位数字
  strong：最少 8 个字符，带 2 个小写、2 个大写、1 个数字和 1 个特殊字符

MB_PASSWORD_LENGTH

• 类型：int

• 默认值：6

  最小密码长度。如果未设置，使用环境变量MB_PASSWORD_COMPLEXITY的值

**MB_PERSISTED_MODEL_REFRESH_CRON_SCHEDULE

• 类型：string

• 默认值："0 0 0/6 * * ? *"

  用于计划刷新持久化模型，类型是使用 cron 语法的字符串。

MB_PERSISTED_MODELS_ENABLED

• 类型：bool

• 默认值：false

  允许将模型保存到源数据库中。

MB_PLUGINS_DIR

• 类型：string

• 默认值："plugins"

  定义插件的目录，用于存储metabase驱动程序。该位置是应添加自定义第三方驱动程序的位置。然后元数据库将在启动时加载驱动程序，可以在日志中进行验证。启动metabse服务的系统用户需要到对此目录有读写权限。通过 JAR 运行时，将在与 JAR 文件相同的位置创建缺省目录plugins。通过 Docker 运行时，默认目录为/plugins。

MB_PREMIUM_EMBEDDING_TOKEN

• 类型：string

• 默认值：null

  用于 Pro 和企业版的许可证令牌，用于在企业版上启用高级功能。它还用于 OSS 版本上已弃用的“高级嵌入”功能。

MB_QP_CACHE_BACKEND

• 类型：string

• 默认值："db"

  当前缓存后端。可动态重新绑定，主要用于测试目的。

MB_QUERY_CACHING_MAX_KB

• 类型：int

• 默认值：1000

  每个查询缓存的最大大小（以 KB 为单位）。

MB_QUERY_CACHING_MAX_TTL

• 类型：int

• 默认值：8640000

  保留任何查询结果缓存的最长时间。默认值为 100 天（以秒为单位）。

MB_QUERY_CACHING_MIN_TTL

• 类型：int

• 默认值：60

  平均查询执行时间超过此秒数，metabase才会缓存其查询

MB_QUERY_CACHING_TTL_RATIO

• 类型：int

• 默认值：10

  缓存保留时间乘数。缓存保留的时间=平均查询时间 X 缓存乘数 。 因此，如果查询平均需要 2 分钟才能完成，并且您输入 10 作为乘数，则其缓存条目将保留 20 分钟。

MB_REDIRECT_ALL_REQUESTS_TO_HTTPS

• 类型：bool

• 默认值：false

  如果网站网址是 HTTPS，则强制所有流量通过重定向使用 HTTPS。相关环境变量MB_SITE_URL

MB_REPORT_TIMEZONE

• 类型：string

• 默认值：null

  执行查询时要使用的时区。默认为系统时区。

MB_SAML_APPLICATION_NAME(商业版支持)

• 类型：string

• 默认值："Metabase"

  此应用名称将用于对身份认证程序的请求。

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"

  用于同步group的 SAML 属性。

MB_SAML_ATTRIBUTE_LASTNAME(商业版支持)

• 类型：字符串

• 默认值："http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname"

  用户姓氏的 SAML 属性。

MB_SAML_ENABLED(商业版支持)

• 类型：bool

• 默认值：false

  是否开启SAML身份验证

MB_SAML_GROUP_MAPPINGS(商业版支持)

• 类型：string

• 默认值："{}"

  包含 SAML 到metabase group映射的 JSON 对象。应采用以下格式：其中key是 SAML group，值是metabase group id 的列表。'{"groupName": [1, 2, 3]}'

MB_SAML_GROUP_SYNC(商业版支持)

• 类型：bool

• 默认值：false

  启用与 SAML 的 group 成员身份同步。

MB_SAML_IDENTITY_PROVIDER_CERTIFICATE(商业版支持)

• 类型：string

• 默认值：null

  SAML认证证书，写证书内容，而不是证书路径

MB_SAML_IDENTITY_PROVIDER_ISSUER(商业版支持)

• 类型：string

• 默认值：null

  配置 IdP 的唯一标识符。其值类似这样：http://www.example.com/141xkex604w0Q5PN724v

MB_SAML_IDENTITY_PROVIDER_URI (商业版支持)

• 类型：string

• 默认值：null

  SAML身份认证url。根据您使用的 IdP，通常是这样的地址：https://your-org-name.okta.com

MB_SAML_KEYSTORE_ALIAS(商业版支持)

• 类型：string

• 默认值："metabase"

  metabase用于签署 SAML 请求的密钥的别名。

MB_SAML_KEYSTORE_PASSWORD(商业版支持)

• 类型：string

• 默认值："changeit"

  用于打开keystore的密码。

MB_SAML_KEYSTORE_PATH(商业版支持)

• 类型：string

• 默认值：null

  用于签署 SAML 请求的 keystore 文件的绝对路径。

MB_SEARCH_TYPEAHEAD_ENABLED

• 类型：bool

• 默认值：true

  在顶部导航栏中使用全局搜索时显示自动建议。

MB_SEND_EMAIL_ON_FIRST_LOGIN_FROM_NEW_DEVICE

• 类型：bool

• 默认值：true

  当用户从新设备登录时，向他们发送电子邮件通知。此外，此变量还控制metabase用于了解用户登录位置的地理编码服务。将此变量设置为 false 也会禁用此反向地理编码功能。

MB_SEND_NEW_SSO_USER_ADMIN_EMAIL(商业版支持)

• 类型：bool

• 默认值：true

  当有新用户通过sso创建，发送邮件通知到管理员group

MB_SESSION_COOKIE_SAMESITE(商业版支持)

• 类型：string
• 默认值："lax"

当使用 FullApp 嵌入, 并且嵌入到的页面域名与metabase实例的域名不在同一个主域名下，你就需要调整这个配置。具体配置参考https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite

MB_SESSION_COOKIES

• 类型：bool

• 默认值：null

  设置为ture，用户登录会话将始终在 MAX_SESSION_AGE（默认为 2 周）中定义的时间后过期。设置为 false 后，用户登录会话将在浏览器关闭时过期。这将覆盖登录时的"remeber me"复选框。

MB_SESSION_TIMEOUT(商业版支持)

• 类型：string

• 默认值：null

  注销非活动用户之前的时间。默认情况下，会话的持续时间根据MAX_SESSION_AGE和MB_SESSION_COOKIES.
  MB_SETUP_TOKEN

• 类型：string

• 默认值：null

  用于表示实例有权创建初始用户的 UUID 令牌。这是在metabase首次启动时由第一个实例创建的;一旦使用，它就会被清除，再也不会使用。

MB_SHOW_DATABASE_SYNCING_MODAL

• 类型：bool

• 默认值：null

  添加下一个数据库连接后是否应显示介绍模式。 如果任何非默认数据库已为此实例完成同步，则默认为 false。

MB_SHOW_HOMEPAGE_DATA

• 类型：bool

• 默认值：null

  通过将其设置为 false 来隐藏主页中的"Our Data"部分

MB_SHOW_HOMEPAGE_XRAYS

• 类型：bool

• 默认值：null

  是否隐藏xray功能

MB_SHOW_LIGHTHOUSE_ILLUSTRATION(商业版支持)

• 类型：string

• 默认值：true

  在主页和登录页面上是否显示灯塔插图。

MB_SHOW_METABOT(商业版支持)

• 类型：bool

• 默认值：true

  在主页上显示 MetaBot 字符。

MB_SITE_LOCALE

• 类型：string

• 默认值："en"

  设置metabase的默认语言。

MB_SITE_NAME

• 类型：string

• 默认值："Metabase"

  设置 metabase 实例名称

MB_SITE_URL

• 类型：string

• 默认值：null

  用户访问metabase的base URL，例如：https://metabase.example.com 或 https://example.com/metabase。此配置对于 SSO 身份验证、电子邮件链接、嵌入等操作至关重要。

MB_SOURCE_ADDRESS_HEADER

• 类型：string

• 默认值：X-Forwarded-For

  通过此标头的值（而不是其远程地址）标识 HTTP 请求的来源。相关环境变量MB_DISABLE_SESSION_THROTTLE

MB_SQL_JDBC_FETCH_SIZE

• 类型：int

• 默认值：500

  结果集的提取大小。我们希望确保 JDBC 结果集对象不会在内存中提取全部结果。仅适用于某些数据库。设置得太高可能会导致内存不足，设置得太低可能会导致性能问题。

MB_SSH_HEARTBEAT_INTERVAL_SEC

• 类型：int

• 默认值：180

  控制建立 SSH 隧道时发送检测信号的频率（以秒为单位）。

MB_SSL_CERTIFICATE_PUBLIC_KEY

• 类型：string

• 默认值：null

  此站点 SSL 证书的 Base-64 编码公钥。指定此项以启用 HTTP 公钥固定。不再建议使用 HPKP。有关详细信息，请参阅 http://mzl.la/1EnfqBf。

MB_START_OF_WEEK

• 类型：string

• 默认值："sunday"

  配置哪一天为一周的开始，新版已经可以通过admin界面直接配置

MB_SUBSCRIPTION_ALLOWED_DOMAINS(商业版支持)

• 类型：string
• 默认值：null

了解Metabase，然后做第一个查询。
Metabase是一个简单而强大的分析工具，任何人都可以从公司的数据中学习和决策，而无需任何技术知识。

Metabase主页

Metabase将在主页上显示一些内容：

自动探索可以查看并另存为仪表盘.
导航侧边栏，列出：
首页按钮返回Metabsse主页。
目录将在其中存储所有查询、仪表盘和模型。你有自己的个人收藏来储存尚未准备好分享的草稿和实验。
数据其中列出了Metabase连接到的所有数据源。
设置（齿轮图标位于导航侧栏顶部）。
你也可以书签您最喜欢的项目，它们将出现在导航侧边栏的顶部。

要打开和关闭导航侧栏，请单击左上角的Metabase徽标。

Metabase查询以及该查询结果以及这些结果的可视化和格式化（即使该可视化只是一个表格). 查询有标题、ID和唯一的URL，您可以复制并与他人共享。

您可以通过筛选和汇总查询的结果，将这些探索保存为新查询，并将查询添加到仪表板但是我们已经超越了自己；在接下来的几个示例中，我们将使用示例数据库作为演示。

在主导航中点击+新建，选择查询。您可以从以下位置开始新查询：

模型
原始表
已保留的查询
现在，让我们从原始数据>示例数据库>Orders开始，Metabase将打开查询生成器。

过滤数据
这个Orders表中有一堆伪造的关于一家虚构公司的产品订单的数据。假设我们想知道：

有多少订单的小计大于40美元？

更确切地说，这个问题可以理解为：“在命令表中的值大于40小计专栏？”

为了找出答案，我们想滤波器数据由领域我们感兴趣的是小计。然后我们要计算筛选的行数。

​

改变视觉效果
Metabase可以以多种方式呈现问题的答案。要更改可视化效果，只需从可视化工具条.

如果我们想以表格的形式检查结果，可以单击页面底部中心的小开关，从图表切换到数据表，然后再切换回来。

对于其他可视化选项，请单击蓝色可视化左下角的按钮。例如，让我们把我们的问题想象成面积图.

与他人分享工作成果
您可以自己使用Metabase，但当您开始与团队或组织中的其他人共享您的查询时，它会变得更加有用。

保存查询
有时候，你会发现需要一次又一次地提出某些，无论是运行定期报告，查找某个重要用户群体的信息，还是仅仅为公司的其他人回答同样的问题。为了避免每次创建重复查询，可以保存查询供以后使用。

要执行此操作，请单击保存右上角的按钮查询生成器.

图1。在共享之前保存您的工作。

Metabase将会尝试给查询一个有意义的名字，但你可以自己命名，这将有助于你和其他人以后找到你的查询。您可以查询添加到目录文件夹。

图2。命名问题，添加有用的说明，然后将其保存到集合中。

我们将创建的查询保存。执行此操作时，Metabase会询问是否要将其添加到新的或现有的仪表盘。选择“是”，对话框将提示您创建新的仪表盘，并为其指定名称和说明。

创建仪表盘
当您有一组要一起查看的查询时，仪表盘非常好。您保存的查询将在仪表盘上显示为部件，您可以调整大小并四处移动。

因此，在您单击按钮创建仪表盘之后，您应该将图表视为一张小部件。

图4。编辑模式下的仪表盘，带有一个查询部件。

你可以移动和调整你的图表，这样你就可以让它看起来像你想要的那样。我们将使我们的数据点更宽一点。当你完成工作时别忘了点击保存，你可以在上面保存你的工作。

直接分享答案
一旦您提出查询或保存了仪表盘，浏览器中的URL将直接链接到该问题或仪表盘。这意味着你可以复制并粘贴到电子邮件或聊天软件，让其他人看到你找到了什么。

只有在共享服务器上安装了Metabase，并且需要为要与之共享的人创建Metabase帐户，这才可用。但是，如果与您共享问题的人没有权限或者如果你把它保存到个人目录，他们不会看到你在分享什么。

为您的查询设置预警
有时候你会想知道一些事情。有几种不同的类型预警您可以进行设置，但想要使用它们，Metabase管理员必须对其进行配置，以便它可以发送电子邮件或向Slack发布消息。

如果您的Metabase中设置了email或Slack，我们可以单击设置按钮在我们的面积图下面打开目标线，然后在切换开关下方的框中输入值“500”，告诉Metabase，只要在一个月内有超过500个订单，我们就会收到通知。

图5.在地区可视化显示选项卡，可以添加目标线并设置目标值。

如果我们保存更改，然后单击钟形图标在右下角，我们可以设置预警。因为我们已经设定了一个目标线，Metabase会自动询问我们是否希望在问题的答案超过或低于目标线时被告知（我们希望“结束”），以及我们希望在第一次还是每次都得到通知（我们将选择第一次）。然后我们告诉Metabase通过电子邮件通知我们，并选择应该接收消息的人：

图6。针对带有目标线的问题设置警报的选项。

什么是 metabase ？

metabase 是一个开放源码的商业智能工具。它允许你提出有关数据的问题，并以合理的格式显示答案，无论是条形图还是详细的表格。

你的问题可以留到以后再问，这样就很容易再问，或者你也可以把问题组合成好看的仪表盘。 metabase 还可以方便地与团队其他成员分享问题和仪表板。

找到你周围的路

所以，你有 gotten Metabase up and running 和 将它与你的数据连接起来。是时候告诉你情况了。

主页

新的开箱即用， metabase 将在主页上向你展示一些东西:

• 一些 自动探索 的表，如果你喜欢它们中的任何一个，你可以查看这些表并将其保存为仪表板。（管理员可以通过单击 Hover 上显示的 X 永久隐藏此部分。
• 一个你或你的队友创建的东西会出现的区域，以及一个链接，可以看到所有的仪表盘，问题和脉冲，你有。
• 连接到 metabase 的数据库列表。（与 X 射线一样，管理员可以通过单击 Hover 上显示的 X 永久隐藏此部分。你总是可以从主导航条中单击“浏览数据”来查看你的数据库和表格。

一旦你创建了一些 dashboards，你在主要的“我们的分析”集合中找到的任何一个都会出现在你所有队友的主页上，这样当他们登录到 metabase 时，他们就会知道该去哪里。

浏览你的数据

如果在安装过程中将数据库连接到 metabase ，你将看到它与 metabase 附带的示例数据集一起列在主页的底部。点击数据库查看其内容。你可以点击一个表格来查看它的行数，也可以点击 Bolt 图标来对表格进行 X 光检查，从而自动查看表格的行数，或单击“图书”图标，转到该表的“数据参考”视图，以了解更多有关它的信息。

探索你的分析

当你和你的团队创建仪表板和集合时，它们将开始显示在主页上。单击“我们的分析”部分中的集合以查看其内容，或单击“浏览所有项目”以查看你和你的团队所做的一切。更多关于探索的信息

提出一个问题或写一个查询

单击 metabase 右上角的 Ask a question 按钮，开始对其中一个表进行新的简单探索，使用 Notebook 编辑器询问一个更详细的自定义问题，或者如果你想真正深入研究，请编写一个新的 SQL 查询。

创建一个新的仪表盘或脉冲

在 metabase 中，仪表板由保存的问题组成，你可以随意安排和调整这些问题的大小。它们是获得你所关心的重要指标和统计数据的一种很好的方式。在 metabase 中，“脉冲”指的是定期发布的报告。它们可以通过电子邮件或两者发送出去。

要制作仪表板或 Pulse，请单击主导航栏右上角的 Plus（+）图标。

使用搜索来快速查找内容

屏幕顶部的搜索栏可以帮助你在瞬间找到表格、仪表盘、集合、保存的问题、指标、段和脉冲。

数据库入门读本

要完全理解如何使用 metabase ，至少对数据库有一个高级的理解是有用的，因此我们接下来将讨论 数据库的基础知识。

可能同步有错误，以前出现过中文编码不能正确同步， 需要把完整的驱动都放到文件夹

前置条件

• 已经部署好 metabase 开发环境

具体步骤

1. 纵览，整体修改会修改以下文件
   

2. 修改 logo 组件，组件位置 frontend/src/metabase/components/LogoIcon.jsx，主要替换render 的 svg 即可，拿自己 logo 的 svg 替换掉现有的
   

3. 修改logo badge 组件，组件位置frontend/src/metabase/public/components/EmbedFrame/LogoBadge.tsx，它主要用在分享页面的底部，这里我们只需要修改下跳转地址即可。像 Metabase 名称这些我们可以通过多语言配置
   

4. 修改语言包，所有语言包都在 locales 目录。这里我们主要修改 Metabase 关键字的翻译
   

5. 替换favicon.ico ,这些都是静态文件在 resource/frontend_client 目录。

6. 执行 ./bin/build 打包命令，重新打 jar 包。如果不确定改的是否有问题，可以单独先跑一下前端验证一下。因为打包耗时会相对比较长。

Metabase的部署非常的简单，通常情况下，我们只需安装好jdk（jdk>=11）环境，然后下载好metabase的jar包，直接在终端中运行就可以了。
但是很多的时候我们并不希望使用metabase的时候还要去手动启动一下metabase，这种情况下我们可以通过工具将metabase做成windows里的一个服务（service），这样我们就可以直接通过window的服务对metabase进行管理了。
在这里我们使用到windows服务管理工具为nssm。

准备工作：

• jdk安装包
• metabase Jar包
• nssm可执行程序

预期配置：

• metabase 工作目录 ：D:\metabase
• nssm.exe 存放目录：D:\metabase

部署步骤：

1. 下载好jdk，双击安装。
2. 下载好metabase，并放到工作目录(D:\metabase)。
3. 下载好nssm.exe，并放到工作目录(D:\metabase)。
4. 用管理员权限打开一个CMD终端

#获取java的路径，此时得到的路径是一个类linux的路径，需要你手动转换成windows的路径，或者直接到安装目录找，找到后在地址栏复制路径。
where java

#切换盘符到工作目录盘符
D:\ 

#切换到工作目录
cd D:\metabase

#创建服务 ，这个创建的服务名为 metabase ，它后面的第一个路径是 java的路径（即前面获取的Java路径），后面第二个路径是metabase.jar的路径 
.\nssm.exe install metabase "C:\Program Files\Eclipse Adoptium\jdk-11.0.16.101-hotspot\bin\java" -jar "D:\metabase\metabase.jar"

#配置环境变量，这里只配置MB_JETTY_PORT，如果需要配置更多的环境变量，直接接着这个环境变量继续写
.\nssm.exe set metabase AppEnvironmentExtra  MB_JETTY_PORT=8001

#设置服务的工作目录
.\nssm.exe set metabase AppDirectory D:\metabase

#设置日志的输入文件
.\nssm.exe set metabase AppStdout D:\metabase\run.log

#设置错误日志的输出文件
.\nssm.exe set metabase AppStderr D:\metabase\err.log

#启动服务
.\nssm.exe start metabase 

#如果要查看配置可以执行.\nssm.exe get metabase  <配置参数名称>，下面是查所有的环境变量
.\nssm.exe get metabase AppEnvironmentExtra

#更多的命令功能可以执行.\nssm.exe -h 查看

bplayer

bplayer

@deson-zhao 可以借用clickhouse实现，clickhouse支持jdbc的表函数，把clickhouse作为中间转换层 就行了

参见知乎https://zhuanlan.zhihu.com/p/611724393

参见知乎https://zhuanlan.zhihu.com/p/612024403

参见知乎https://zhuanlan.zhihu.com/p/612210413

参见知乎文章https://zhuanlan.zhihu.com/p/612508886