razvanilin/chartbrew

Chartbrew Docker镜像文档

镜像概述和主要用途

Chartbrew是一款开源Web应用，能够直接连接数据库和API，利用数据创建美观的图表。它提供图表构建器、可编辑仪表板、可嵌入图表、查询与请求编辑器以及团队协作功能，适用于数据可视化、报表生成和团队数据协作场景。

核心功能和特性

• 多数据源连接：直接连接各类数据库（如MySQL、PostgreSQL等）和API，无需复杂的数据预处理
• 图表构建器：可视化创建多种类型的图表，支持自定义样式和配置
• 可编辑仪表板：灵活配置和编辑数据仪表板，实时展示关键指标
• 可嵌入图表：生成可嵌入到其他应用或网站的图表，方便数据共享
• 查询与请求编辑器：内置编辑器支持编写数据库查询和API请求，简化数据获取流程
• 团队协作：支持多用户协作，共享图表和仪表板，适合团队数据协作场景

使用场景和适用范围

• 企业数据分析：连接业务数据库，可视化关键业务指标，辅助决策
• 团队数据监控：创建实时数据仪表板，监控项目进度、系统性能等
• 业务报表生成：快速生成可分享的数据分析报表，支持定期更新
• 开发与测试：开发过程中可视化API返回数据或数据库内容，辅助调试

使用方法和配置说明

前提条件

• 已运行的MySQL（5+）或PostgreSQL（12.5+）数据库（需创建空数据库供Chartbrew使用）
• Redis（v6+）服务（用于缓存和会话管理）

Docker部署步骤

1. 拉取Docker镜像

sh
docker pull razvanilin/chartbrew

2. 生成加密密钥

Chartbrew需要32字节的AES加密密钥（CB_ENCRYPTION_KEY），可通过以下命令生成：

sh
node -e "console.log(require('crypto').randomBytes(32).toString('hex'))"

3. 运行Docker容器

使用以下命令启动Chartbrew容器，替换环境变量值为实际配置：

sh
docker run -p 4019:4019 -p 4018:4018 \
  -e CB_ENCRYPTION_KEY=your_32_bytes_key \  # 步骤2生成的32字节密钥
  -e CB_API_HOST=0.0.0.0 \                  # API服务绑定地址
  -e CB_API_PORT=4019 \                     # API服务端口
  -e CB_DB_HOST=host.docker.internal \      # 数据库主机地址（本地数据库可用host.docker.internal）
  -e CB_DB_PORT=3306 \                      # 数据库端口（MySQL默认3306，PostgreSQL默认5432）
  -e CB_DB_NAME=chartbrew \                 # 数据库名称（需提前创建）
  -e CB_DB_USERNAME=root \                  # 数据库用户名
  -e CB_DB_PASSWORD=password \              # 数据库密码
  -e CB_REDIS_HOST=host.docker.internal \   # Redis主机地址
  -e CB_REDIS_PORT=6379 \                   # Redis端口
  -e CB_REDIS_PASSWORD=password \           # Redis密码（如无密码可省略）
  -e VITE_APP_CLIENT_HOST=http://localhost:4018 \  # 前端访问地址
  -e VITE_APP_CLIENT_PORT=4018 \            # 前端服务端口
  -e VITE_APP_API_HOST=http://localhost:4019 \    # API访问地址
  razvanilin/chartbrew

4. 访问应用

容器启动后，访问 http://localhost:4018 即可打开Chartbrew，创建首个用户账户开始使用。

环境变量说明

数据来源支持

Chartbrew支持多种数据来源，最新支持列表请参见Chartbrew官网。

相关资源

• 完整文档
• https://github.com/chartbrew/chartbrew/discussions
• ***社区