codex-proxy-rs/deploy/README.md

部署

本目录包含 Dockerfile、Compose 文件和 Docker 配置模板。

Compose

首次部署先复制样例配置：

mkdir -p .runtime/data .runtime/logs
cp deploy/config.example.yaml .runtime/config.yaml

deploy/config.example.yaml 是 Docker 部署模板。Compose 默认使用仓库根目录的 .runtime/：

• .runtime/config.yaml -> /app/config.yaml
• .runtime/data -> /app/data
• .runtime/logs -> /app/logs

复制后必须设置 admin.default_password。空值、长度不足 12 位或常见弱口令会被后端拒绝。

如果前面还有 Nginx、Caddy、Cloudflare Tunnel 等反向代理，确保反代正常传递 CF-Connecting-IP、X-Real-IP 或 X-Forwarded-For。后端会按这组头自动解析真实客户端 IP；没有这些头时回落到直连 peer IP。

构建并启动：

docker compose -f deploy/docker-compose.yml build
docker compose -f deploy/docker-compose.yml up -d

可以通过环境变量覆盖宿主机路径。容器内始终通过 CPR_CONFIG_FILE=/app/config.yaml 读取挂载后的配置：

CPR_CONFIG_FILE=/path/to/config.yaml \
CPR_DATA_DIR=/path/to/data \
CPR_LOG_DIR=/path/to/logs \
docker compose -f deploy/docker-compose.yml up -d

构建

Docker 构建上下文保持仓库根目录：

docker build -f deploy/Dockerfile -t codex-proxy-rs:latest .

也可以用 Compose 构建：

docker compose -f deploy/docker-compose.yml build

需要写入版本元数据时：

CPR_VERSION="$(ruby -ryaml -e 'puts YAML.load_file("release/version.yaml").fetch("version").delete_prefix("v")')" \
CPR_GIT_SHA="$(git rev-parse HEAD)" \
CPR_BUILD_TIME="$(date -u +%Y-%m-%dT%H:%M:%SZ)" \
docker compose -f deploy/docker-compose.yml build