wpengine/site-deploy

wpengine/site-deploy

镜像概述与主要用途

wpengine/site-deploy 是一个基础镜像，用于构建版本控制系统（VCS）集成，帮助用户将网站部署到 WP Engine 平台。该镜像提供标准化部署流程，支持通过环境变量配置、SSH密钥认证和自定义参数实现灵活高效的网站部署。

核心功能与特性

• VCS集成支持：作为基础镜像，可构建与各类版本控制系统的集成，实现部署流程自动化
• 环境变量配置：通过 .env 文件和环境变量灵活设置部署参数，如目标环境、源路径、过滤规则等
• SSH安全认证：支持通过私钥环境变量（WPE_SSHG_KEY_PRIVATE）进行安全的SSH密钥认证
• 自定义部署选项：可配置PHP代码检查（PHP_LINT）、缓存清理（CACHE_CLEAR）、传输标志（FLAGS）等参数
• 文件传输控制：支持通过FLAGS自定义文件传输规则，如排除隐藏文件、设置递归传输等
• 轻量级部署：使用docker run命令即可启动，支持本地目录挂载作为网站源路径

使用场景与适用范围

适用于需要将本地网站或版本控制系统中的网站项目部署到 WP Engine 的用户，特别适合：

• 需要标准化部署流程的开发团队
• 希望通过配置文件管理部署参数的场景
• 需集成版本控制系统实现自动化部署的需求

详细使用方法与配置说明

构建镜像

通过 make 命令构建和管理镜像版本：

sh
make build       # 本地构建镜像
make version     # 构建镜像并创建版本标签
make list-images # 显示所有已标记的镜像版本
make clean       # 删除所有已标记的镜像版本

运行部署流程

1. 准备工作

• 使用 make build 构建 wpengine/site-deploy:latest 镜像
• 进入本地网站项目的根目录
• 创建 .env 文件配置部署参数

[!WARNING]
由于 docker run 不会从 .env 文件的变量中去除双引号，请勿使用双引号包裹整个变量值。对于包含空格的标志值，需用单引号或双引号包裹（如 --filter=':= .gitignore'），且标志与值之间必须包含等号（如 --filter=':= .gitignore' 而非 --filter ':= .gitignore'）。

2. 配置 .env 文件

创建 .env 文件并设置以下变量（根据需求修改值）：

sh
# 必填项。目标 WP Engine 环境名称。
WPE_ENV=yourinstall
# 可选项。默认值如下所示。
REMOTE_PATH=
SRC_PATH=.
PHP_LINT=FALSE
CACHE_CLEAR=TRUE
SCRIPT=
FLAGS=-azvr --inplace --exclude='.*'

变量说明：

• WPE_ENV：必填，目标 WP Engine 环境的安装名称
• REMOTE_PATH：可选，远程路径，默认空值
• SRC_PATH：可选，本地源路径，默认 .（当前目录）
• PHP_LINT：可选，是否启用PHP代码检查，默认 FALSE
• CACHE_CLEAR：可选，是否清理缓存，默认 TRUE
• SCRIPT：可选，自定义部署脚本路径，默认空值
• FLAGS：可选，文件传输标志，默认 -azvr --inplace --exclude='.*'

3. 设置 SSH 私钥环境变量

导出包含私有SSH密钥的环境变量（替换密钥文件路径）：

sh
export WPE_SSHG_KEY_PRIVATE=`cat ~/.ssh/my_sshg_key_rsa`

4. 执行部署命令

运行以下Docker命令启动部署流程：

sh
docker run --rm \
    -e "WPE_SSHG_KEY_PRIVATE" \
    --env-file ./.env \
    -v $(pwd):/site \
    --workdir=/site \
    wpengine/site-deploy:latest

命令参数说明：

• --rm：部署完成后自动删除容器
• -e "WPE_SSHG_KEY_PRIVATE"：传递SSH私钥环境变量
• --env-file ./.env：加载 .env 文件中的配置变量
• -v $(pwd):/site：将当前目录挂载到容器内 /site 目录
• --workdir=/site：设置容器工作目录为 /site
• wpengine/site-deploy:latest：使用的镜像名称及标签