dittofeed/dittofeed-admin-cli

Dittofeed Admin CLI 镜像文档

镜像概述

Dittofeed Admin CLI 镜像是开源客户参与平台 Dittofeed 的官方管理命令行工具容器化版本。该工具提供了对 Dittofeed 平台的配置管理、用户权限控制、活动监控等核心管理能力，简化平台部署、维护与日常操作流程。

核心功能与特性

• 配置管理：支持平台初始化配置、系统参数修改、第三方服务（如邮件/推送服务）集成配置。
• 用户与权限管理：提供用户创建、角色分配、权限细粒度控制，管理平台访问权限。
• 活动与工作流管理：创建、编辑、启停客户互动活动及自动化工作流，监控执行状态与结果。
• 系统监控：查看服务健康状态、活动执行日志、性能指标，辅助故障排查与问题定位。
• 数据操作：支持用户数据、活动数据的导入/导出，满足数据备份与迁移需求。

使用场景与适用范围

• 开发环境：开发人员调试平台配置、验证功能正确性。
• 生产环境：系统管理员执行日常管理操作（如权限调整、活动监控）。
• 运维场景：运维人员进行平台初始化、数据备份、故障排查。
• 自动化集成：嵌入 CI/CD 流程或脚本，实现配置自动化部署与更新。

使用方法与配置说明

前提条件

• 已安装 Docker 引擎（推荐 20.10+ 版本）。
• 已部署 Dittofeed 平台服务，且 CLI 可访问其 API 服务（需提供 API 地址与认证密钥）。

基本使用命令

通过 Docker 运行 CLI 容器的基本格式：

bash
docker run --rm -e [环境变量] dittofeed/admin-cli [命令] [参数]

环境变量说明

常用命令示例

1. 查看帮助信息
   获取所有可用命令与参数说明：

   bash
   docker run --rm dittofeed/admin-cli --help
   

2. 初始化平台配置
   首次部署后执行基础配置初始化：

   bash
   docker run --rm \
     -e DITTOFEED_API_URL=http://dittofeed-api:3000 \
     -e DITTOFEED_API_KEY=your-secure-api-key \
     dittofeed/admin-cli config init
   

3. 创建管理员用户
   添加具有管理员权限的用户：

   bash
   docker run --rm \
     -e DITTOFEED_API_URL=http://dittofeed-api:3000 \
     -e DITTOFEED_API_KEY=your-secure-api-key \
     dittofeed/admin-cli users create \
       --email admin@example.com \
       --role admin \
       --name "System Admin"
   

4. 监控活动状态
   查看当前所有客户互动活动的执行状态：

   bash
   docker run --rm \
     -e DITTOFEED_API_URL=http://dittofeed-api:3000 \
     -e DITTOFEED_API_KEY=your-secure-api-key \
     dittofeed/admin-cli campaigns list --status active
   

高级配置：使用环境变量文件

通过挂载环境变量文件简化命令，避免重复输入参数：

bash
# 创建本地环境变量文件
echo "DITTOFEED_API_URL=[***]" > .dittofeed.env
echo "DITTOFEED_API_KEY=your-secure-api-key" >> .dittofeed.env

# 使用文件运行 CLI
docker run --rm --env-file .dittofeed.env dittofeed/admin-cli users list