在 Docker 上运行 Metabase

要获得快速、可靠、安全的部署,且无需自托管的工作或隐藏成本,请查看Metabase 云

Metabase 通过 Dockerhub 提供官方 Docker 镜像,可用于在任何运行 Docker 的系统上进行部署。

如果您尝试在 Docker 上升级 Metabase 版本,请查看这些升级说明

开源版快速入门

使用此快速入门在本地运行 Metabase 的开源版本。有关在生产环境中运行 Metabase 的说明,请参见下文。

假设您已安装并运行 Docker,获取最新的 Docker 镜像

docker pull metabase/metabase:latest

然后启动 Metabase 容器

docker run -d -p 3000:3000 --name metabase metabase/metabase

这将默认在 3000 端口启动一个 Metabase 服务器。

可选:要查看开源 Metabase 初始化时的日志,请运行

docker logs -f metabase

启动完成后,您可以在 http://localhost:3000 访问您的开源 Metabase。

要在不同的端口运行您的开源 Metabase,例如端口 12345

docker run -d -p 12345:3000 --name metabase metabase/metabase

专业版或企业版快速入门

如果您有 Metabase 专业版或企业版许可证令牌,并且想要在本地运行 Metabase,请使用此快速入门。有关在生产环境中运行 Metabase 的说明,请参见下文。

假设您已安装并运行 Docker,获取最新的 Docker 镜像

docker pull metabase/metabase-enterprise:latest

然后启动 Metabase 容器

docker run -d -p 3000:3000 --name metabase metabase/metabase-enterprise

这将默认在 3000 端口启动一个 Metabase 服务器。

可选:要查看 Metabase 初始化时的日志,请运行

docker logs -f metabase

启动完成后,您可以在 http://localhost:3000 访问您的专业版或企业版 Metabase。

要在不同的端口运行您的专业版或企业版 Metabase,例如端口 12345

docker run -d -p 12345:3000 --name metabase metabase/metabase-enterprise

生产环境安装

Metabase 附带一个嵌入式 H2 数据库,它使用文件系统存储自己的应用程序数据。这意味着,如果您删除容器,您将丢失 Metabase 应用程序数据(您的查询、仪表盘、集合等)。

如果您想在生产环境中运行 Metabase,则需要将应用程序数据存储在生产就绪数据库中。

一旦您为 Metabase 预置了一个数据库(例如 Postgres)来存储其应用程序数据,您只需向 Metabase 提供连接信息和凭据,以便 Metabase 可以连接到它。

在生产环境中运行 Docker

假设您通过运行以下命令设置了一个 Postgres 数据库

createdb metabaseappdb

无需添加任何表;Metabase 将在启动时创建它们。并假设该数据库可通过 my-database-host:5432 访问,用户名为 name,密码为 password

这是一个告诉 Metabase 使用该数据库的 Docker 命令示例

docker run -d -p 3000:3000 \
  -e "MB_DB_TYPE=postgres" \
  -e "MB_DB_DBNAME=metabaseappdb" \
  -e "MB_DB_PORT=5432" \
  -e "MB_DB_USER=name" \
  -e "MB_DB_PASS=password" \
  -e "MB_DB_HOST=my-database-host" \
   --name metabase metabase/metabase

请记住,Metabase 将从您的 Docker 容器内部进行连接,因此请确保:a) 您使用的是完全限定的主机名,或 b) 您已在容器的 /etc/hosts 文件中设置了正确的条目。

迁移到生产环境安装

如果您已经使用默认应用程序数据库 (H2) 运行 Metabase,并且希望使用生产就绪的应用程序数据库而不丢失您的应用程序数据(您的查询、仪表盘等),请参阅从 H2 迁移到生产数据库

Docker compose YAML 文件示例

以下是使用 PostgreSQL 数据库 metabaseappdb 运行 Metabase 的 docker-compose.yml 示例文件

这是一个示例文件,不适用于在生产环境中运行 Metabase。请参考我们的指南如何在生产环境中运行 Metabase

services:
  metabase:
    image: metabase/metabase:latest
    container_name: metabase
    hostname: metabase
    volumes:
      - /dev/urandom:/dev/random:ro
    ports:
      - 3000:3000
    environment:
      MB_DB_TYPE: postgres
      MB_DB_DBNAME: metabaseappdb
      MB_DB_PORT: 5432
      MB_DB_USER: metabase
      MB_DB_PASS: mysecretpassword
      MB_DB_HOST: postgres
    networks:
      - metanet1
    healthcheck:
      test: curl --fail -I http://localhost:3000/api/health || exit 1
      interval: 15s
      timeout: 5s
      retries: 5
  postgres:
    image: postgres:latest
    container_name: postgres
    hostname: postgres
    environment:
      POSTGRES_USER: metabase
      POSTGRES_DB: metabaseappdb
      POSTGRES_PASSWORD: mysecretpassword
    networks:
      - metanet1
networks:
  metanet1:
    driver: bridge

额外的 Docker 维护和配置

自定义 Metabase Jetty 服务器

您可以通过在 Docker 运行命令中设置环境变量,使用自定义 Metabase Jetty Web 服务器中的任何自定义设置。

Docker 特定的环境变量

除了标准自定义设置之外,还有两个 Docker 特定的环境变量 MUIDMGID,用于设置 Metabase 在 Docker 容器中运行时使用的用户和组 ID。这些设置使得当文件(例如应用程序数据库)在主机和容器之间共享时,可以匹配文件权限。

以下是使用由您的账户拥有并存储在您的主目录中的数据库文件的方法

docker run -d -v ~/my-metabase-db:/metabase.db --name metabase -e MB_DB_FILE=/metabase.db -e MUID=$UID -e MGID=$GID -p 3000:3000 metabase/metabase

设置 Java 时区

最好将您的 Java 时区设置为您希望所有报告显示的时区。您只需指定 JAVA_TIMEZONE 环境变量,该变量会被 Metabase 启动脚本获取。例如

docker run -d -p 3000:3000 \
  -e "JAVA_TIMEZONE=US/Pacific" \
  --name metabase metabase/metabase

复制应用程序数据库

容器中应用程序数据库的默认位置是 /metabase.db/metabase.db.mv.db。您可以使用以下命令将此目录从容器中复制出来(将 CONTAINER_ID 替换为实际的容器 ID 或名称,如果容器命名为 metabase 则替换为 metabase

docker cp CONTAINER_ID:/metabase.db ./

数据库内容将留在名为 metabase.db 的目录中。

挂载映射的文件存储卷

为了将数据持久化到容器外部并在容器启动之间可用,我们可以在容器内部挂载一个本地文件路径。

docker run -d -p 3000:3000 \
  -v ~/metabase-data:/metabase-data \
  -e "MB_DB_FILE=/metabase-data/metabase.db" \
  --name metabase metabase/metabase

当您启动容器时,Metabase 将使用位于 ~/metabase-data/metabase.db 的数据库文件 (MB_DB_FILE),而不是其默认位置。我们正在将该文件夹从本地文件系统挂载到容器中。

如果容器停止,如何找回配置

如果您之前使用本地数据库运行并配置了 Metabase,然后停止了容器,除非您使用 docker rm 命令删除了容器,否则您的数据仍然存在。要恢复您之前的配置

1. 使用 docker ps -a 命令查找已停止的容器。它会像这样显示

docker ps -a | grep metabase
    ca072cd44a49        metabase/metabase        "/app/run_metabase.sh"   About an hour ago   Up About an hour          0.0.0.0:3000->3000/tcp   metabase
    02e4dff057d2        262aa3d0f714             "/app/run_metabase.sh"   23 hours ago        Exited (0) 23 hours ago                            pedantic_hypatia
    0d2170d4aa4a        262aa3d0f714             "/app/run_metabase.sh"   23 hours ago        Exited (0) 23 hours ago                            stoic_lumiere

一旦您确定了包含您的配置的已停止容器,请保存最左侧列中的容器 ID 以备下一步使用。

2. 使用 docker commit 从包含您配置的已停止容器创建新的自定义 Docker 镜像。

docker commit ca072cd44a49 mycompany/metabase-custom
sha256:9ff56186de4dd0b9bb2a37c977c3a4c9358647cde60a16f11f4c05bded1fe77a

3. 使用 docker run 运行您的新镜像,以重新启动并运行。

docker run -d -p 3000:3000 --name metabase mycompany/metabase-custom
430bb02a37bb2471176e54ca323d0940c4e0ee210c3ab04262cb6576fe4ded6d

您应该已经恢复了之前配置的 Metabase 安装。如果不是您预期的版本,请尝试不同的已停止容器并重复这些步骤。

添加外部依赖项或插件

要添加外部依赖 JAR 文件(例如 Oracle 或 Vertica JDBC 驱动程序或第三方 Metabase 驱动程序),您需要

  • 在主机系统中创建 plugins 目录,以及
  • 绑定该目录,使其可作为路径 /plugins 供 Metabase 使用(使用 --mount-v/--volume)。

例如,如果您的主机系统上有一个名为 /path/to/plugins 的目录,您可以使用 --mount 选项使其内容可供 Metabase 使用,如下所示

docker run -d -p 3000:3000 \
  --mount type=bind,source=/path/to/plugins,destination=/plugins \
  --name metabase metabase/metabase

请注意,Metabase 将使用此目录来提取默认 Metabase 分发版中捆绑的插件(例如 SQLite 等各种数据库的驱动程序),因此它必须是 Docker 可读写的。

使用 Docker Secrets 隐藏敏感参数

为了隐藏您的连接参数,您可以使用 Docker Secrets 将所有参数放入文件中,以便 Docker 在启动容器之前读取并将它们加载到内存中。

以下是一个 docker-compose.yml 文件示例,用于启动带有 secrets 的 Metabase Docker 容器以连接到 PostgreSQL 数据库。

除了此示例 yml 文件之外,您还需要创建两个文件

  • db_user.txt
  • db_password.txt

这些文件应与 docker-compose.yml 位于同一目录中。将 db_user 放入 db_user.txt 文件中,将 db_password 放入 db_password.txt 文件中。

请注意带有 secret 的环境变量后面的“_FILE”

services:
  metabase:
    image: metabase/metabase:latest
    container_name: metabase
    hostname: metabase
    volumes:
      - /dev/urandom:/dev/random:ro
    ports:
      - 3000:3000
    environment:
      MB_DB_TYPE: postgres
      MB_DB_DBNAME: metabase
      MB_DB_PORT: 5432
      MB_DB_USER_FILE: /run/secrets/db_user
      MB_DB_PASS_FILE: /run/secrets/db_password
      MB_DB_HOST: postgres
    networks:
      - metanet1
    secrets:
      - db_password
      - db_user
    healthcheck:
      test: curl --fail -I http://localhost:3000/api/health || exit 1
      interval: 15s
      timeout: 5s
      retries: 5
  postgres:
    image: postgres:latest
    container_name: postgres
    hostname: postgres
    environment:
      POSTGRES_USER_FILE: /run/secrets/db_user
      POSTGRES_DB: metabase
      POSTGRES_PASSWORD_FILE: /run/secrets/db_password
    networks:
      - metanet1
    secrets:
      - db_password
      - db_user
networks:
  metanet1:
    driver: bridge
secrets:
  db_password:
    file: db_password.txt
  db_user:
    file: db_user.txt

我们目前支持以下环境变量作为密钥使用

  • MB_DB_USER
  • MB_DB_PASS
  • MB_DB_CONNECTION_URI
  • MB_EMAIL_SMTP_PASSWORD
  • MB_EMAIL_SMTP_USERNAME
  • MB_LDAP_PASSWORD
  • MB_LDAP_BIND_DN

为了让 Metabase 容器读取文件并将其内容用作密钥,环境变量名称需要像上面解释的那样附加一个“_FILE”。

这是一个示例文件,不适用于在生产环境中运行 Metabase。请参考我们的指南如何在生产环境中运行 Metabase

故障排除

请参阅故障排除指南中的“运行 Metabase”。

继续设置

安装 Metabase 后,是时候设置并连接到您的数据库了。

阅读其他Metabase 版本的文档。

© . All rights reserved.