budibase/worker

Budibase Worker 服务镜像文档

一、镜像概述

Budibase Worker 是 Budibase 自托管架构中的后台服务组件，专门用于处理系统异步任务与后台操作。作为 Budibase 完整自托管部署的核心组成部分，该镜像需配合 Budibase 其他服务（如应用服务器、数据库、Redis 等）通过 Docker Compose 协同运行，无法独立使用。

二、核心功能与特性

1. 异步任务处理
   负责执行系统中的非实时任务，如数据导出、报表生成、批量操作等，避免阻塞前端应用响应。

2. 定时任务调度
   支持预设时间触发的自动化任务，如定期数据备份、系统清理、定时通知等。

3. 后台操作支持
   为 Budibase 系统提供底层支持，包括资源同步、状态更新、日志处理等后台运维操作。

三、使用场景与适用范围

适用场景

• Budibase 自托管部署：用户在私有基础设施（服务器、云环境等）部署 Budibase 时，需通过 Docker Compose 将该镜像作为组合服务的一部分运行。
• 生产/测试环境：适用于需要稳定处理后台任务的各类场景，包括企业内部系统、团队协作平台等。

限制

• 必须与 Budibase 其他核心服务（如 budibase/app-server、数据库、Redis）配合使用，无法单独部署运行。
• 需通过 Docker Compose 管理服务依赖关系，不建议单独使用 docker run 命令启动。

四、使用方法

4.1 前置条件

• 已安装 Docker 与 Docker Compose。
• 已准备 Budibase 自托管部署所需的其他服务（如 PostgreSQL 数据库、Redis 缓存等）。

4.2 Docker Compose 配置示例

Budibase Worker 需通过 Docker Compose 集成到整体架构中，以下为典型配置示例：

yaml
version: '3.8'

services:
  worker:
    image: budibase/worker
    restart: unless-stopped
    depends_on:
      - redis
      - db
      - minio
    environment:
      # 数据库连接配置（需与 Budibase 主数据库一致）
      - DB_HOST=db
      - DB_PORT=5432
      - DB_USER=budibase
      - DB_PASSWORD=your-db-password
      - DB_NAME=budibase
      # Redis 连接配置（用于任务队列）
      - REDIS_URL=redis://redis:6379
      # 对象存储配置（用于文件存储）
      - MINIO_URL=http://minio:9000
      - MINIO_ACCESS_KEY=your-minio-access-key
      - MINIO_SECRET_KEY=your-minio-secret-key
      # 日志级别（可选，默认 info）
      - LOG_LEVEL=info
      # 时区配置（可选，默认 UTC）
      - TZ=Asia/Shanghai
    networks:
      - budibase-network

  # 依赖服务示例（需与 Worker 协同运行）
  redis:
    image: redis:alpine
    restart: unless-stopped
    networks:
      - budibase-network

  db:
    image: postgres:14-alpine
    restart: unless-stopped
    environment:
      - POSTGRES_USER=budibase
      - POSTGRES_PASSWORD=your-db-password
      - POSTGRES_DB=budibase
    volumes:
      - postgres-data:/var/lib/postgresql/data
    networks:
      - budibase-network

  minio:
    image: minio/minio
    restart: unless-stopped
    command: server /data --console-address ":9001"
    environment:
      - MINIO_ROOT_USER=your-minio-access-key
      - MINIO_ROOT_PASSWORD=your-minio-secret-key
    volumes:
      - minio-data:/data
    networks:
      - budibase-network

networks:
  budibase-network:
    driver: bridge

volumes:
  postgres-data:
  minio-data:

4.3 环境变量说明

Budibase Worker 的行为通过环境变量配置，核心变量说明如下：

注意：完整环境变量列表及详细配置说明，请参考 Budibase 官方文档：[***]

五、部署与启动

1. 将上述 Docker Compose 配置保存为 docker-compose.yml。
2. 根据实际环境修改环境变量值（如数据库密码、MinIO 密钥等）。
3. 执行以下命令启动服务：

   bash
   docker-compose up -d
   

4. 检查服务状态：

   bash
   docker-compose ps
   

六、注意事项

• Budibase Worker 依赖 Redis 进行任务队列管理，依赖 PostgreSQL 存储任务元数据，需确保这些服务正常运行。
• 服务启动顺序：建议先启动 db、redis、minio 等依赖服务，再启动 worker。
• 日志查看：通过 docker-compose logs -f worker 实时查看 Worker 服务日志，用于排查任务执行问题。