mikefez/phoenix

Phoenix

镜像概述和主要用途

Phoenix容器设计用于检测远程代码仓库分支的新提交，随后关闭并重启（立即或准备就绪时），拉取最新变更。其核心机制是：启动时使用环境变量提供的SSH私钥配置认证，检出或拉取指定分支，执行用户命令作为后台任务；PID 1进程定期检查远程分支新提交，根据配置执行立即重启或创建更新标记文件，待后台任务完成后容器退出并重启（需配置自动重启策略），从而实现代码自动更新与应用持续运行的循环。

核心功能和特性

• SSH密钥管理：自动将环境变量提供的SSH私钥写入~/.ssh/id_rsa，支持Git仓库认证
• Git仓库操作：首次启动检出指定分支，后续启动拉取最新代码
• 后台任务执行：在仓库目录中以后台进程方式执行用户指定命令（如shell脚本、Python应用等）
• 提交检测机制：定期检查远程分支新提交，可配置检查间隔（默认30秒）
• 双更新策略：
  • RESTART：检测到新提交后立即关闭容器（依赖自动重启策略更新）
  • FILE：创建GIT_UPDATE_DETECTED文件，供后台任务感知并执行收尾操作后退出
• 自定义配置：支持指定仓库路径、分支、额外系统包安装等

使用场景和适用范围

适用于需要自动更新代码并重启的场景，包括但不限于：

• 持续部署小型应用或脚本
• 定时任务脚本的自动更新
• 需要快速响应代码变更的开发/测试环境
• 轻量级服务的自动版本迭代

参数说明

部署示例

docker-compose配置

yaml
---
version: "3"
services:
  custom-script-phoenix-will-manage:
    image: mikefez/Phoenix
    container_name: custom-script-phoenix-will-manage
    environment:
      - SSH_PRIVATE_KEY  # 建议在.env文件中设置，也可直接提供
      - GIT_REPO=git@github.com:MikeFez/Phoenix.git  # 必填：远程仓库地址
      - LAUNCH_CMD=sh launch.sh  # 可选：若仓库中存在launch.sh，可省略
      - REPO_BRANCH=master  # 可选：默认master分支
      - GIT_LOCAL_FOLDER=/opt/local_repository  # 可选：默认仓库路径
      - UPDATE_METHOD=FILE  # 可选：默认FILE策略
      - ADDITIONAL_APK=libssl-dev,python3  # 可选：安装额外依赖包
      - SECONDS_BETWEEN_CHECKS=30  # 可选：默认30秒检查间隔
    volumes:  # 卷不是必需的，但可添加以保持容器与主机时间一致
      - /etc/localtime:/etc/localtime:ro 
      - /etc/timezone:/etc/timezone:ro
    restart: unless-stopped  # 必须启用此策略以确保容器重启并更新代码

关键配置说明

• restart: unless-stopped：核心配置，确保容器退出后自动重启，从而拉取最新代码并重新执行命令
• SSH_PRIVATE_KEY：若仓库为私有，需提供包含换行符替换为\n的私钥（例如：-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQE...\n-----END RSA PRIVATE KEY-----）
• UPDATE_METHOD=FILE：适用于需要优雅关闭的场景，后台脚本可通过检测GIT_UPDATE_DETECTED文件执行数据保存、连接关闭等操作后退出，触发容器重启