ToolJet 社区版 (ToolJet CE) 技术文档

1. 镜像概述和主要用途

ToolJet 社区版（CE）是一款开源低代码框架，旨在通过最小化工程投入快速构建和部署内部工具。其核心价值在于：

• 提供拖放式前端构建器，支持在几分钟内创建复杂响应式界面
• 无缝连接多种数据源，包括数据库、API 端点、SaaS 工具和对象存储服务
• 支持自托管部署，满足企业数据隐私和合规需求

主要用途包括构建内部数据仪表板、业务流程工具、客户关系管理（CRM）系统、数据查询工具等，无需从零开发前端和后端逻辑。

2. 核心功能和特性

2.1 可视化应用构建能力

• 40+ 内置响应式组件：表格、图表、列表、表单、进度条等，覆盖常见界面需求
• 多页面应用支持：可构建包含多个页面的复杂应用，支持页面间导航
• 桌面与移动适配：自定义布局宽度，确保在不同设备上的显示效果

2.2 数据集成能力

• 40+ 数据源连接：支持数据库（PostgreSQL、MongoDB、Elasticsearch 等）、API 端点（支持 OpenAPI 规范导入和 OAuth2 授权）、SaaS 工具（Stripe、Slack、Google Sheets、Airtable、Notion 等）及对象存储服务（S3、GCS、MinIO 等）
• 无代码查询编辑器：为所有支持的数据源提供可视化查询配置界面
• 数据转换与处理：通过 JavaScript/Python 代码片段转换查询结果

2.3 协作与开发效率

• 多人实时编辑：支持团队成员同时在线编辑应用
• 协作评论功能：在画布任意位置添加评论并@团队成员
• 版本控制：应用支持多版本管理，具备完整发布周期
• 代码扩展能力：支持在构建器中嵌入 JavaScript/Python 代码片段（如动态设置组件属性：status === 'success' ? 'green' : 'red'）

2.4 部署与安全

• 自托管支持：兼容 Docker、Kubernetes、Heroku、AWS EC2、Google Cloud Run 等多种部署环境
• 内置数据库：提供 ToolJet Database 作为无代码数据存储方案
• 安全加密：所有凭证通过 aes-256-gcm 算法加密存储
• 数据代理模式：仅作为数据传输代理，不存储业务数据
• 细粒度访问控制：支持团队级和应用级权限管理
• SSO 集成：兼容多种单点登录（SSO）提供商

2.5 扩展能力

• 插件系统：通过*** CLI 工具（@tooljet/cli）快速开发自定义数据源连接器

3. 使用场景和适用范围

3.1 典型使用场景

• 内部数据仪表板：如 GitHub 贡献者排行榜、加密货币价格监控面板
• 业务流程工具：如客户支持工单系统、项目进度跟踪工具
• 数据管理工具：如 AWS S3 文件浏览器、数据库记录管理界面
• 集成型应用：如结合 Slack 和 Airtable 的 *** CRM 系统

3.2 适用范围

• 企业 IT 团队：快速响应业务部门工具需求，减少重复开发
• 业务分析师：无需依赖开发资源，自行构建数据查询和可视化工具
• 初创公司：用低代码方式快速搭建内部运营工具，降低技术成本

4. 使用方法和配置说明

4.1 Docker 快速部署

4.1.1 本地测试部署

通过以下命令可在本地快速启动 ToolJet（含内置数据库，数据持久化到卷）：

bash
docker run \
  --name tooljet \
  --restart unless-stopped \
  -p 80:80 \  # 映射容器 80 端口到主机 80 端口
  -v tooljet_data:/var/lib/postgresql/13/main \  # 持久化数据库数据
  tooljet/try:latest  # 使用最新测试镜像

参数说明：

• --name tooljet：指定容器名称为 tooljet
• --restart unless-stopped：容器退出时自动重启（除非手动停止）
• -p 80:80：端口映射，主机端口:容器端口
• -v tooljet_data:/var/lib/postgresql/13/main：创建名为 tooljet_data 的卷，挂载到容器内 PostgreSQL 数据目录，确保数据持久化

4.1.2 生产环境部署（Docker Compose 示例）

对于生产环境，建议使用 docker-compose 管理服务，支持自定义配置（如修改端口、数据库连接等）。以下是基础配置示例：

yaml
# docker-compose.yml
version: '3'

services:
  tooljet:
    image: tooljet/tooljet-ce:latest  # 使用社区版最新镜像
    container_name: tooljet-app
    restart: unless-stopped
    ports:
      - "8080:80"  # 自定义主机端口为 8080
    volumes:
      - tooljet_data:/var/lib/postgresql/13/main
    environment:
      - NODE_ENV=production  # 指定生产环境
      # 如需自定义数据库或其他配置，添加环境变量（详见***文档）
    networks:
      - tooljet-network

networks:
  tooljet-network:
    driver: bridge

volumes:
  tooljet_data:  # 声明数据卷

启动命令：

bash
docker-compose up -d  # 后台启动服务

4.2 配置参数和环境变量

ToolJet 支持通过环境变量自定义配置，常见参数如下（完整列表请参考***文档）：

注意：生产环境中必须手动设置 SECRET_KEY_BASE 并持久化，否则容器重启后可能导致数据无法解密。

5. 文档和资源

5.1 ***文档

• 快速入门
• 数据源参考（含数据库、API、SaaS 工具等连接指南）
• 组件参考（40+ 内置组件的属性和用法）

5.2 教程和示例

• GitHub 贡献者排行榜
• 加密货币仪表板
• *** CRM 系统
• AWS S3 文件浏览器

6. 社区支持和反馈

• Slack：加入社区讨论，获取实时支持
• GitHub：提交 Issue（bug 报告/功能请求）
• *******：关注 @ToolJet 获取产品更新

7. 许可证信息

ToolJet 社区版采用 GNU Affero General Public License v3.0 许可证，详见 LICENSE。

---

徽章信息
!Docker Cloud Build Status
!GitHub contributors
!GitHub stars
!GitHub release
!GitHub license