codemancers/dockup

Dockup

注意：已弃用

master分支已弃用，建议使用k8s-ui分支。

Dockup使用docker-compose为服务创建一次性staging环境，可在提交PR时自动部署，或通过Slack等工具手动触发，助力团队快速预览应用变更。

核心功能

• ✅ 通过Github webhook为PR自动创建staging环境
• ✅ 提供API和UI部署Git仓库中的应用
• ✅ 支持多容器环境
• ✅ 用Letsencrypt自动生成/续期SSL证书
• ✅ 基础认证功能
• ✅ 自动清理过期环境
• ✅ 查看运行中应用的日志

使用场景

1. PR测试：提交PR时自动部署环境，方便团队预览变更
2. 手动部署：通过Slack触发临时环境创建
3. 多容器测试：模拟生产环境测试复杂架构应用
4. 安全访问：通过基础认证和SSL保障环境安全

配置说明

安装步骤

1. 克隆仓库
2. 复制.env.example为.env并替换占位值
3. 运行：

   bash
   docker-compose up
   

支持的后端

通过DOCKUP_BACKEND指定：

• compose：使用项目根目录的docker-compose.yaml
• helm：使用helm文件夹中的Helm包
• fake：模拟部署（默认，适用于UI开发）

环境变量配置

所有必要变量在.env.example中，更多配置见apps/dockup/lib/dockup/config.ex。

基础认证

设置DOCKUP_HTPASSWD为htpasswd生成的凭据（可通过在线工具生成），适用于应用和日志页面。

Git URL白名单

仅白名单中的仓库可部署，通过导航栏“Whitelisted URLs”添加。

Github Bot配置

生成具有repo权限的OAuth令牌，设置到DOCKUP_GITHUB_OAUTH_TOKEN以启用webhook。

API示例

部署应用：

bash
curl -XPOST -d '{"git_url":"https://github.com/code-mancers/project.git","branch":"master","callback_url":"fake_callback"}' -H "Content-Type: application/json" http://localhost:4000/api/deployments

开发环境

1. 安装Elixir：brew install elixir
2. 项目目录执行：

   bash
   ./scripts/setup && mix deps.get
   iex -S mix phx.server
   # 推荐带Google OAuth启动：
   GOOGLE_CLIENT_ID=<ID> GOOGLE_CLIENT_SECRET=<密钥> GOOGLE_CLIENT_DOMAINS=codemancers.com mix phx.server
   

访问UI：http://localhost:4000

生产环境

设置DOCKUP_BASE_DOMAIN（如dockup.yourdomain.com），界面将通过ui.dockup.yourdomain.com访问，便于使用通配符SSL证书。

UI设计致谢

感谢Sleekr（[***] ===FULL_DESC===