configcat/proxy

ConfigCat Proxy Docker镜像

概述

ConfigCat Proxy Docker镜像是一个容器化解决方案，旨在帮助用户在自有基础设施中部署和运行功能标志（Feature Flag）评估服务。通过该镜像，您可以将功能标志的评估逻辑部署到私有环境，实现对数据隐私、服务可用性及基础设施的自主控制。

核心功能和特性

• 自托管部署：在用户控制的基础设施中运行功能标志评估服务，避免对外部服务的依赖。
• 容器化设计：基于Docker构建，支持快速部署、扩缩容及集成到现有容器化环境（如Kubernetes）。
• 兼容性保障：与ConfigCat功能标志管理平台无缝兼容，确保评估逻辑与云端服务一致。
• 轻量级运行：优化的镜像体积，降低资源占用，适合在各类环境中高效运行。

使用场景和适用范围

• 数据隐私与合规：适用于对用户数据隐私、数据驻留地有严格合规要求的企业（如***、***行业）。
• 降低外部依赖：需减少对第三方服务依赖，确保核心业务功能不受外部服务中断影响的场景。
• 性能与延迟控制：对功能标志评估延迟敏感的应用，通过本地部署降低网络延迟。
• 私有环境部署：在隔离网络或内网环境中部署功能标志服务，满足内部系统集成需求。

使用方法和配置说明

基本使用

通过以下命令快速启动ConfigCat Proxy容器：

bash
docker run -d --name configcat-proxy -p 8080:8080 docker.xuanyuan.run/configcat/configcat-proxy

• -d：后台运行容器
• --name configcat-proxy：指定容器名称
• -p 8080:8080：映射容器端口到主机（默认端口为8080，可根据需求调整）

配置选项

ConfigCat Proxy支持通过环境变量或配置文件进行自定义配置，常用参数包括：

• CONFIGCAT_SDK_KEY：（必填）用于连接ConfigCat平台的SDK密钥，获取方式见ConfigCat控制台
• PROXY_PORT：自定义服务端口（默认8080）
• CACHE_TTL：功能标志配置缓存过期时间（默认30秒）

示例（带环境变量配置）：

bash
docker run -d --name configcat-proxy \
  -p 8081:8081 \
  -e CONFIGCAT_SDK_KEY="your-sdk-key" \
  -e PROXY_PORT=8081 \
  -e CACHE_TTL=60 \
  docker.xuanyuan.run/configcat/configcat-proxy

持久化与数据管理

若需持久化配置或日志，可通过挂载主机目录实现：

bash
docker run -d --name configcat-proxy \
  -p 8080:8080 \
  -e CONFIGCAT_SDK_KEY="your-sdk-key" \
  -v /path/on/host/config:/app/config \  # 挂载配置目录
  -v /path/on/host/logs:/app/logs \      # 挂载日志目录
  configcat/configcat-proxy

Docker Compose示例

创建docker-compose.yml文件简化部署：

yaml
version: '3'
services:
  configcat-proxy:
    image: docker.xuanyuan.run/configcat/configcat-proxy
    container_name: configcat-proxy
    ports:
      - "8080:8080"
    environment:
      - CONFIGCAT_SDK_KEY=your-sdk-key
      - PROXY_PORT=8080
      - CACHE_TTL=30
    volumes:
      - ./config:/app/config
      - ./logs:/app/logs
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

更多信息

完整配置文档、高级用法及故障排查，请参考官方GitHub仓库：https://github.com/configcat/configcat-proxy