flosumhub/agent

Flosum Agent Docker镜像文档

镜像概述与主要用途

Flosum Agent是一款轻量级应用，旨在促进组织数据中心与Salesforce数据中心之间的数据传输。该应用可部署在企业内部基础设施或客户控制的隔离区（DMZ），通过安全认证机制（如证书绑定）及HTTPS加密协议，确保数据传输的完整性与安全性。本Docker镜像提供了Flosum Agent的容器化部署方案，支持Docker Compose及Docker Secrets管理，简化部署流程并增强敏感信息安全性。

核心功能与特性

• 安全数据传输：采用HTTPS协议加密所有数据传输，支持证书绑定机制，确保Salesforce数据中心与本地应用间的数据完整性。
• Docker化部署：支持通过Docker Compose快速部署，提供含/不含Docker Secrets的配置方案，适配不同安全需求。
• 认证与授权：基于OAuth 2.0协议，通过SALESFORCE_TOKEN实现应用间认证，仅存储令牌而非密码，降低安全风险。
• 邮件通知：集成SMTP配置，可发送数据同步、提交状态的邮件通知（成功/失败/初始同步），支持AWS SES邮件打开跟踪。

使用场景与适用范围

适用于需要在企业内部系统与Salesforce平台间进行安全数据交互的场景，尤其适合对数据传输安全性要求高的行业（如***、***、企业级SaaS），可部署于内部数据中心或隔离区（DMZ）以满足合规需求。

使用方法与配置说明

部署前提

• Flosum将提供Docker Hub访问信息，用户无需单独获取Docker license即可拉取镜像。
• 需提前准备SALESFORCE_TOKEN（通过Flosum Connected App生成，详见下文“令牌获取步骤”）。

部署命令

使用Docker Stack部署Flosum Agent服务栈：

bash
sudo docker stack deploy -c <docker-compose文件名> --with-registry-auth <栈名称>

Docker Compose配置示例

不含Docker Secrets的配置（基础版）

yaml
version: '3.8'
services:
  node:
    image: flosum/agent-node:4.x.x
    environment:
      NODE_ENV: production
      SALESFORCE_TOKEN: xxxxxxxxxxxxxxxxxxxx  # 敏感令牌明文配置（不推荐生产环境）
      SMTP_HOST: 'xxxx'                       # SMTP服务器地址
      SMTP_PORT: xxxx                         # SMTP服务器端口
      SMTP_SECURE: false                      # 是否启用TLS加密
      SMTP_TRACK_OPENINGS: false              # 邮件打开跟踪（仅AWS SES支持）
      SMTP_FROM: 'sender@email.com'           # 发件人邮箱
      SMTP_AUTH_TYPE: 'login'                 # 认证类型（仅支持login）
      SMTP_AUTH_USER: 'username'              # SMTP认证用户名
      SMTP_AUTH_PASSWORD: 'password'          # SMTP认证密码
    volumes:
      - <本地数据路径>:/home/node/data        # 挂载数据卷（持久化 Agent 数据）

含Docker Secrets的配置（推荐生产环境）

yaml
version: '3.8'
services:
  node:
    image: flosum/agent-node:4.x.x
    environment:
      NODE_ENV: production
      SMTP_HOST: 'xxxx'                       # SMTP服务器地址
      SMTP_PORT: xxxx                         # SMTP服务器端口
      SMTP_SECURE: false                      # 是否启用TLS加密
      SMTP_TRACK_OPENINGS: false              # 邮件打开跟踪（仅AWS SES支持）
      SMTP_FROM: 'sender@email.com'           # 发件人邮箱
      SMTP_AUTH_TYPE: 'login'                 # 认证类型（仅支持login）
      SMTP_AUTH_USER: 'username'              # SMTP认证用户名
      SMTP_AUTH_PASSWORD: 'password'          # SMTP认证密码
      SALESFORCE_TOKEN_FILE: /run/secrets/salesforce_token  # 从Secrets文件加载令牌
    secrets:
      - salesforce_token                      # 引用外部Secrets
      
secrets:
  salesforce_token:
    external: true  # 表示Secrets需提前创建（外部管理，如Docker Swarm Secrets）

SALESFORCE_TOKEN获取与生成机制

令牌生成机制

SALESFORCE_TOKEN基于Salesforce Connected App框架生成，通过OAuth 2.0协议实现外部应用与Salesforce的API集成。Connected App会生成包含refresh_token、client_secret和client_id的字符串，用于获取访问令牌并授权Agent访问Salesforce组织。

令牌获取步骤

1. 登录Flosum平台，通过应用启动器进入 “Flosum-Git > 设置”。
2. 在设置页面选择 “代码质量” 选项卡，向下滚动至 “Heroku服务授权令牌” 区块，点击 “获取令牌” 按钮。
3. 在新打开的浏览器标签页中，滚动至页面底部即可查看生成的SALESFORCE_TOKEN。

SMTP邮件通知配置说明

SMTP配置用于发送数据同步及提交活动的状态通知，触发场景包括初始同步、同步/提交成功或失败。通知接收者根据场景自动确定：

• 初始同步及Flosum→Git提交：通知发送至启动流程的用户***。
• Git→Flosum提交：通知发送至Git服务webhook关联的授权用户***。

核心环境变量说明

安全注意事项

• 敏感信息管理：推荐使用Docker Secrets存储SALESFORCE_TOKEN等敏感信息，避免通过环境变量明文传递。
• 数据传输安全：所有数据交互均通过HTTPS协议加密，确保传输过程中数据不被篡改。
• 认证安全：Flosum仅存储令牌而非密码，授权通过集成用户执行，降低凭证泄露风险。