rollout/simple-proxy

Cloudbees Feature Management SDKs 简单代理

镜像概述和主要用途

该镜像为Cloudbees Feature Management (CB FM) SDKs提供简单代理功能，用于转发Rox SDK请求至CB FM服务。当使用CB FM SDK的服务器或客户端处于无互联网访问环境、位于防火墙后、缺乏CORS权限，或需要完全控制网络请求时，此代理尤为实用。

注意：为使SDK与代理通信，需同时配置SDK，具体方法参见官方文档。

核心功能和特性

环境变量配置

以下环境变量可用于配置代理行为：

• PORT（默认值：8080）
  Docker内部HTTP端口。

• HTTPS_PORT（默认值：8090）
  Docker内部HTTPS端口。

• DISABLE_HTTPS（默认值：false）
  启用HTTPS需设置有效的证书文件和密钥文件；设为true可禁用HTTPS。

• CERTIFICATE（默认值：'./ssl/server.cert'）
  证书文件路径。

• CERTIFICATE_KEY（默认值：'./ssl/server.key'）
  证书密钥文件路径。

• USER（默认值：undefined）
  SDK与代理间的基本认证用户名（需在SDK端配置，参见文档）。

  说明：需同时设置USER和PASSWORD才能启用基本认证。

• PASSWORD（默认值：undefined）
  SDK与代理间的基本认证密码（需在SDK端配置，参见文档）。

  说明：需同时设置USER和PASSWORD才能启用基本认证。

• LOG_LEVEL（默认值：info）
  日志级别，可选值：'debug' | 'info' | 'warn' | 'error' | 'silent'（详见http-proxy-middleware文档）。

使用场景和适用范围

适用于以下场景：

• 使用CB FM SDK的服务器/客户端无直接互联网访问权限
• 服务器/客户端位于防火墙后，无法直接连接CB FM服务
• 客户端存在CORS权限限制，无法直接与CB FM服务通信
• 需要对SDK与CB FM服务间的网络请求进行完全控制

使用方法和配置说明

Docker运行模板

bash
docker run -e PORT=<内部HTTP端口> -e HTTPS_PORT=<内部HTTPS端口> -e USER=<基本认证用户名> -e PASSWORD=<基本认证密码> -e CERTIFICATE=<证书文件路径> -e CERTIFICATE_KEY=<证书密钥文件路径> -v <本地路径>:<Docker内部路径> -p <外部HTTP端口>:<内部HTTP端口> -p <外部HTTPS端口>:<内部HTTPS端口> -d docker.xuanyuan.run/rollout/simple-proxy

使用示例

示例1：使用默认环境变量（仅HTTP，端口80）

bash
docker run -p:80:8080 -d docker.xuanyuan.run/rollout/simple-proxy

示例2：自定义内部HTTP端口并启用HTTPS（假设证书文件位于~/localPath）

bash
docker run -e PORT=9000 -e HTTPS_PORT=9090 -v ~/localPath:/dockerInternalPath -p:80:9000 -p:443:9090 -d docker.xuanyuan.run/rollout/simple-proxy

示例3：自定义端口、启用HTTPS并配置基本认证（证书文件位于~/localPath）

bash
docker run -e PORT=9000 -e HTTPS_PORT=9090 -e USER=username -e PASSWORD=somePassword -e CERTIFICATE=/usr/src/app/mySsl/ser.cert -e CERTIFICATE_KEY=/usr/src/app/mySsl/ser.key -v ~/localPath:/usr/src/app/mySsl -p:80:9000 -p:443:9090 -d docker.xuanyuan.run/rollout/simple-proxy