automaticmode/active_workflow

ActiveWorkflow

镜像概述

ActiveWorkflow 是一款强大的自动化工作流引擎，旨在通过“软件代理（Software Agents）”帮助企业或产品实现业务流程自动化。这些自主运行的代理实体可以按计划执行或响应外部触发器，支持使用任意编程语言编写。它们能够无缝连接各类 API、处理信息、执行常规任务，从而全面赋能内部或外部工作流的自动化管理。

核心功能和特性

• 软件代理架构：基于自主代理实体运行，支持无人值守的自动化任务执行。
• 多语言支持：代理逻辑可使用任意编程语言编写，提供极高的开发灵活性。
• 灵活的触发机制：支持基于时间调度的定时任务以及基于外部事件触发的响应式任务。
• API 与数据集成：原生支持连接各类外部 API，进行数据抓取、处理和流转。
• 12-Factor 设计：遵循 12-Factor App 最佳实践，通过环境变量进行灵活配置。

使用场景和适用范围

• 业务流程自动化：自动化处理重复性的内部审批、数据录入或状态流转等常规业务任务。
• 系统集成与 API 编排：连接不同的 SaaS 服务或内部系统，实现跨平台的数据同步与 API 调用编排。
• 定时任务与监控：定期抓取外部数据、生成报表，或监控系统状态并在异常时触发告警。

部署与使用指南

ActiveWorkflow 依赖 PostgreSQL 数据库进行数据持久化。默认实例由三个核心容器组成：web（Web 服务）、scheduler（调度器）和 worker（工作节点）。

1. 启动 PostgreSQL 数据库（可选）

如果您已有运行中的 PostgreSQL 实例，可跳过此步骤。

使用 Docker 启动一个 PostgreSQL 数据库实例：

bash
docker run --rm --name activeworkflow-db \
  -e POSTGRES_PASSWORD=activeworkflowpassword \
  -e POSTGRES_USER=activeworkflow \
  -v activeworkflow-data:/var/lib/postgresql/data \
  -d docker.io/postgres

此命令将使用指定的用户名和密码启动数据库，并挂载 activeworkflow-data 数据卷以持久化数据。

2. 运行 ActiveWorkflow

使用官方镜像启动 ActiveWorkflow 的三个核心组件：

bash
# 启动 Web 服务
docker run --rm --name activeworkflow-web \
  --link activeworkflow-db:postgres \
  -e DATABASE_URL=postgres://activeworkflow:activeworkflowpassword@postgres/active_workflow \
  -e SECRET_KEY_BASE=secretrandomstring \
  -e CREATE_DATABASE=true \
  -e DISABLE_SSL=true \
  -p 3000:3000 \
  -d docker.io/automaticmode/active_workflow

# 启动调度器 (Scheduler)
docker run --rm --name activeworkflow-scheduler \
  --link activeworkflow-db:postgres \
  -e DATABASE_URL=postgres://activeworkflow:activeworkflowpassword@postgres/active_workflow \
  -e SECRET_KEY_BASE=secretrandomstring \
  -e CREATE_DATABASE=true \
  -e DISABLE_SSL=true \
  -d docker.io/automaticmode/active_workflow bundle exec rails runner bin/scheduler.rb

# 启动工作节点 (Worker)
docker run --rm --name activeworkflow-worker \
  --link activeworkflow-db:postgres \
  -e DATABASE_URL=postgres://activeworkflow:activeworkflowpassword@postgres/active_workflow \
  -e SECRET_KEY_BASE=secretrandomstring \
  -e CREATE_DATABASE=true \
  -e DISABLE_SSL=true \
  -d docker.io/automaticmode/active_workflow bundle exec script/delayed_job -n 2 run

访问系统： 启动完成后，可通过浏览器访问 http://localhost:3000。默认管理员账号为 admin，密码为 password。

注意：上述命令假设数据库容器名为 activeworkflow-db 并使用了 --link 进行连接。若数据库部署在其他环境，请相应修改 --link 参数或直接通过 DATABASE_URL 指定正确的连接地址。生产环境强烈建议使用 Nginx 或 Apache 等 Web 服务器提供 SSL 终端，并移除 DISABLE_SSL 变量。

3. 停止服务

停止所有 ActiveWorkflow 容器：

bash
docker stop activeworkflow-web activeworkflow-scheduler activeworkflow-worker

环境变量配置说明

ActiveWorkflow 通过环境变量进行配置，支持以下参数：

数据库配置

• DATABASE_URL：数据库连接字符串，格式为 postgres://{username}:{password}@{hostname}/{database_name}。设置此项可替代下方的独立数据库变量。
• DATABASE_USERNAME：数据库用户名。
• DATABASE_PASSWORD：数据库密码。
• DATABASE_HOST：数据库主机地址。
• DATABASE_NAME：数据库名称。

初始化与种子数据

• CREATE_DATABASE：设为 true 时，Web 进程将自动创建数据库。通常在首次运行且未提前创建数据库时使用，该操作是幂等的。
• DO_NOT_MIGRATE：设为 true 可跳过数据库迁移。默认情况下，Web 进程会自动执行迁移脚本以更新 Schema。
• DO_NOT_SEED：设为 true 可跳过数据库初始化种子数据。默认会创建示例工作流和初始用户。
• SEED_EMAIL：初始管理员用户的***地址。
• SEED_USERNAME：初始管理员用户的用户名。
• SEED_PASSWORD：初始管理员用户的密码。 (注：若未设置上述三个 SEED 变量，系统将默认创建用户名为 admin、密码为 password、为 admin@example.com 的管理员。若已存在则跳过创建。)

系统与安全配置

• SECRET_KEY_BASE：用于加密数据（特别是 Session 信息）的随机字符串，生产环境务必修改为复杂随机值。
• DISABLE_SSL：设为 true 允许在不使用 SSL 加密的情况下运行（适用于本地测试）。生产环境应通过反向代理提供 SSL 并移除此变量。
• PORT：Web 进程监听的端口号。
• AGENT_LOG_LENGTH：每个代理保留的日志条目数量，默认保留 200 条。

性能与并发配置

• WEB_CONCURRENCY：Web 进程用于处理请求的进程数。
• RAILS_MAX_THREADS：Web 进程每个进程使用的最大线程数。

SMTP 邮件配置

• SMTP_DOMAIN：SMTP 域名。
• SMTP_SERVER：SMTP 服务器地址。
• SMTP_PORT：SMTP 服务器端口。
• SMTP_AUTHENTICATION：SMTP 认证方式（none 或 plain）。
• SMTP_SSL：是否启用 SSL（false 或 true）。
• SMTP_USER_NAME：SMTP 用户名。
• SMTP_PASSWORD：SMTP 密码。
• SMTP_ENABLE_STARTTLS_AUTO：部分服务器需要将其设为 true 以启用 STARTTLS。
• SMTP_OPENSSL_VERIFY_MODE：OpenSSL 验证模式，生产环境建议使用 peer，测试环境可使用 none。

自定义构建镜像

如需自行构建 ActiveWorkflow 镜像，可克隆官方仓库并使用 docker build 命令：

bash
git clone https://github.com/automaticmode/active_workflow.git
cd active_workflow
docker build -t {yourname}/active_workflow .

许可证

ActiveWorkflow 基于 MIT 许可证开源。 注：该 Docker 镜像内可能包含基础发行版中的其他软件（如 Bash 等）及主软件的直接或间接依赖，这些组件可能受其各自的开源许可证约束。