craftercms/deployer

CrafterCMS Deployer Docker 镜像文档

1. 镜像概述和主要用途

CrafterCMS Deployer Docker 镜像是 CrafterCMS 内容管理系统的核心组件之一，专门用于自动化部署内容到各类目标环境。该镜像封装了 Crafter Deployer 服务，支持将 CrafterCMS 管理的内容（如网站、应用资源等）部署至开发、测试、生产等不同环境，实现部署流程的标准化和自动化。

注意：SNAPSHOT 版本镜像仅对 CrafterCMS 企业版用户开放，社区版用户需使用稳定发布版本。

2. 核心功能和特性

• 多环境部署支持：适配开发、测试、预生产及生产环境，满足不同阶段部署需求。
• 自动化部署流程：支持基于事件触发（如内容发布）或定时任务的自动化部署。
• 与 CrafterCMS 生态集成：无缝对接 Crafter Engine、Studio 等组件，确保内容部署一致性。
• 灵活的部署策略：支持自定义部署规则（如增量部署、全量部署、回滚机制）。
• 配置驱动部署：通过配置文件定义部署目标、路径、权限等参数，支持动态调整。
• 轻量级容器设计：基于精简基础镜像，资源占用低，部署启动速度快。

3. 使用场景和适用范围

• 开发团队自动化部署：开发人员通过 Deployer 快速将本地内容部署至开发环境，加速迭代。
• 测试环境快速交付：测试团队一键部署最新内容至测试环境，验证功能完整性。
• 生产环境可靠发布：支持生产环境高可用部署，确保内容发布稳定性和一致性。
• CI/CD 流水线集成：作为 CI/CD 流程的部署节点，与 Jenkins、GitLab CI 等工具集成。
• 多环境配置统一管理：通过集中配置文件或环境变量，统一管理不同环境的部署参数。

4. 使用方法和配置说明

4.1 获取镜像

4.1.1 稳定版镜像（社区版/企业版通用）

bash
docker pull craftercms/deployer:${VERSION}

其中 ${VERSION} 为具体版本号（如 4.0.0），可从 CrafterCMS 官方发布页 获取。

4.1.2 SNAPSHOT 版镜像（仅企业版）

需通过企业版授权访问私有镜像仓库：

bash
docker pull registry.craftercms.com/craftercms/deployer:${SNAPSHOT_VERSION}

4.2 基本运行（docker run）

4.2.1 最小化启动（默认配置）

bash
docker run -d \
  --name crafter-deployer \
  -p 9191:9191 \
  craftercms/deployer:4.0.0

默认暴露 9191 端口（Deployer API 端口），使用内置 H2 数据库存储部署记录。

4.2.2 自定义配置启动（挂载配置文件）

bash
docker run -d \
  --name crafter-deployer \
  -p 9191:9191 \
  -v /path/to/deployer/config:/opt/crafter/deployer/conf \  # 挂载自定义配置
  -v /path/to/deployer/targets:/opt/crafter/deployer/targets  # 挂载部署目标配置
  -e LOG_LEVEL=INFO \
  craftercms/deployer:4.0.0

4.3 配置管理

4.3.1 配置方式

• 环境变量：通过 -e 参数注入运行时配置（优先级最高）。
• 配置文件挂载：将本地配置文件挂载至容器内 /opt/crafter/deployer/conf 目录，覆盖默认配置。
• 部署目标配置：部署目标（如服务器路径、FTP/SFTP 地址）通过配置文件定义，默认路径为 /opt/crafter/deployer/targets，建议挂载本地目录持久化管理。

4.4 docker-compose 部署示例

yaml
version: '3.8'

services:
  crafter-deployer:
    image: craftercms/deployer:4.0.0
    container_name: crafter-deployer
    ports:
      - "9191:9191"
    environment:
      - LOG_LEVEL=INFO
      - DB_TYPE=mysql
      - DB_URL=jdbc:mysql://mysql:3306/crafter_deployer
      - DB_USER=deployer_user
      - DB_PASSWORD=deployer_pass
    volumes:
      - ./deployer/conf:/opt/crafter/deployer/conf  # 自定义配置
      - ./deployer/targets:/opt/crafter/deployer/targets  # 部署目标配置
      - deployer-data:/opt/crafter/deployer/data  # 持久化部署记录
    depends_on:
      - mysql

  mysql:
    image: mysql:8.0
    container_name: crafter-deployer-mysql
    environment:
      - MYSQL_ROOT_PASSWORD=root_pass
      - MYSQL_DATABASE=crafter_deployer
      - MYSQL_USER=deployer_user
      - MYSQL_PASSWORD=deployer_pass
    volumes:
      - mysql-data:/var/lib/mysql

volumes:
  deployer-data:
  mysql-data:

4.5 环境变量说明

4.6 持久化数据

Deployer 运行过程中会生成部署记录、日志等数据，建议通过挂载卷持久化：

• 部署记录：/opt/crafter/deployer/data
• 日志文件：/opt/crafter/deployer/logs（可通过 LOG_DIR 环境变量自定义）

5. 注意事项

• SNAPSHOT 版本：仅企业版用户可获取，需联系 CrafterCMS 支持团队获取私有仓库访问权限。
• 配置文件格式：部署目标配置文件需遵循 Crafter Deployer 配置规范（XML/JSON 格式）。
• 网络访问：确保容器可访问部署目标服务器（如 FTP/SFTP 服务、远程文件系统）及关联的 CrafterCMS 组件（如 Engine、数据库）。