yieldr/unleash

Unleash Server Docker镜像文档

镜像概述和主要用途

Unleash Server Docker镜像是Unleash功能标志管理服务的官方部署镜像，已发布至Docker Hub。Unleash是一款功能标志管理工具，帮助开发团队安全地发布、测试和管理软件功能。该镜像提供了便捷的部署方式，支持快速启动Unleash服务，适用于本地开发、测试及生产环境。

核心功能和特性

• 便捷部署：可直接从Docker Hub拉取镜像并启动，无需手动配置依赖
• 灵活的数据库配置：支持通过DATABASE_URL环境变量直接指定数据库连接，或通过DATABASE_URL_FILE环境变量从文件读取数据库密钥（更安全的实践）
• 本地开发支持：提供docker-compose配置，可一键启动PostgreSQL数据库和Unleash服务，简化本地开发环境搭建
• 版本管理：支持通过Git标签管理镜像版本，自动触发Docker Hub构建新标签

使用场景和适用范围

• 开发团队本地开发环境快速搭建Unleash服务
• 生产环境部署Unleash功能标志管理系统
• 需要安全管理功能发布、进行A/B测试的团队
• 希望通过容器化方式简化Unleash部署和维护的场景

使用方法和配置说明

从Docker Hub拉取并运行镜像

1. 拉取镜像

   bash
   docker pull unleashorg/unleash-server:3.1
   

2. 运行容器
   使用环境变量指定数据库连接：

   bash
   docker run -d -e DATABASE_URL=postgres://user:pass@10.200.221.11:5432/unleash unleashorg/unleash-server
   

   安全最佳实践：不建议将密钥直接作为环境变量传递。可通过DATABASE_URL_FILE指定包含数据库连接信息的文件路径，让Unleash从文件读取密钥：

   bash
   docker run -d -e DATABASE_URL_FILE=/path/to/database-url-file -v /local/path/to/file:/path/to/database-url-file unleashorg/unleash-server
   

本地开发环境使用

1. 克隆仓库

   bash
   git clone <仓库地址>
   cd <仓库目录>
   

2. 使用docker-compose启动
   项目提供docker-compose配置，可同时启动PostgreSQL数据库和Unleash服务：

   bash
   docker-compose build
   docker-compose up
   

3. 环境要求
   使用的docker-compose版本为3.3，需满足：

   • Docker引擎版本 17.06.0+
   • Docker Compose版本 1.14.0+
     更多兼容性信息参见Docker官方兼容性矩阵

版本升级

当Unleash Server版本更新时，需通过Git标签同步更新镜像版本：

1. 创建版本标签

   bash
   git tag -a 3.1.1 -m "升级至unleash-server 3.1.1"
   git push origin master --follow-tags
   

2. 更新次要版本标签（可选）

   bash
   git tag -d 3.1  # 删除旧标签
   git push origin :3.1  # 推送删除操作
   git tag -a 3.1 -m "更新3.1标签"  # 创建新标签
   git push origin master --follow-tags
   

   推送标签后，Docker Hub将自动触发新标签的构建流程。