Files
social-app/deploy/README.md
T
qzl 01c36eb32e refactor: 移除前端 Mock API,新增共享组件,优化认证流程
- 删除 mock_api_client、mock_calendar_service、mock_history_service
- 新增 fixed_length_code_input、link_button、message_composer 共享组件
- 优化登录/注册/密码重置页面使用新组件
- 简化 injection.dart 移除 mock 分支
- 更新 env.dart 配置(BACKEND_URL 替换 API_URL)
- 后端 agentscope 工具和测试更新
- 重构 AGENTS.md 文档结构
- 新增 deploy/ 目录和 protocol 文档
2026-03-12 16:41:45 +08:00

3.6 KiB

Production Deploy Package

本目录是单机 docker compose 的生产交付包,架构为:

  • 应用层:litellm + web + worker-critical + worker-default + worker-bulk + init-job
  • 中间件:redis
  • 数据与认证:云 Supabase(通过环境变量访问)
  • 反向代理:由服务器侧 nginx 托管(不在本目录编排)

交付物

  1. deploy/build-prod-image.sh:构建并导出生产镜像。
  2. deploy/docker-compose.prod.yml:生产 Docker Compose 编排。
  3. deploy/.env.prod.example:生产环境变量模板。
  4. deploy/README.md:部署说明书。

安全基线

  • deploy/.env.prod.example 仅作为模板,真实密钥请在服务器上填写到 deploy/.env.prod,不要提交仓库。
  • Redis 密码必填;为空时容器会启动失败。
  • 后端镜像默认使用非 root 用户运行。
  • 容器间通信仅走 Docker 内网(redislitellm 服务名)。

目录结构

deploy/
├── build-prod-image.sh
├── docker-compose.prod.yml
├── .env.prod.example
└── README.md

一次性交付:构建生产镜像

在仓库根目录执行:

bash deploy/build-prod-image.sh

成功后会产出:

  • 镜像名:social-app-backend:prod(可用 SOCIAL_BACKEND_IMAGE 覆盖)
  • 归档文件:deploy/social-app-backend-prod.tar.gz

如果你要把镜像拷贝到另一台服务器,传输该 .tar.gz 后执行:

gunzip -c social-app-backend-prod.tar.gz | docker load

启动流程(生产)

1) 检查环境变量

先创建生产环境变量文件:

cp deploy/.env.prod.example deploy/.env.prod

确认 deploy/.env.prod 至少包含以下关键变量(云 Supabase 与数据库连接):

  • SOCIAL_SUPABASE__PUBLIC_URL
  • SOCIAL_SUPABASE__ANON_KEY
  • SOCIAL_SUPABASE__SERVICE_ROLE_KEY
  • SOCIAL_SUPABASE__JWT_SECRET
  • SOCIAL_DATABASE__HOST
  • SOCIAL_DATABASE__PORT
  • SOCIAL_DATABASE__NAME
  • SOCIAL_DATABASE__USER
  • SOCIAL_DATABASE__PASSWORD
  • SOCIAL_REDIS__PASSWORD

说明:

  • 容器内通信统一使用 Docker 内网:SOCIAL_REDIS__HOST=redisSOCIAL_LITELLM__HOST=litellm
  • SOCIAL_WEB__HOST/SOCIAL_LITELLM__BIND_HOST 是容器内监听地址,生产建议保持 0.0.0.0

2) 启动常驻服务

docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml up -d redis litellm web worker-critical worker-default worker-bulk

3) 执行一次性 bootstrap

docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml run --rm init-job

4) 查看状态与日志

docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml ps
docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml logs -f web

停止与重启

停止:

docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml down

重启:

docker compose --env-file deploy/.env.prod -f deploy/docker-compose.prod.yml up -d

nginx 对接建议

  • 反向代理到 127.0.0.1:${SOCIAL_WEB__PORT}(默认 5775)。
  • 仅开放 nginx 对外端口;应用容器仅发布到本机回环地址。
  • 如果 nginx 运行在宿主机,web 需要保留 127.0.0.1:host_port:container_port 端口映射。
  • 如果 nginx 也运行在 Docker 同网络内,可以移除 web.ports,改为容器内反向代理(例如 proxy_pass http://web:5775)。

已知约束

  • LiteLLM 会在容器启动时动态生成 /tmp/litellm-proxy-config.yaml,依赖 SOCIAL_LLM__PROVIDER_KEYS__* 已配置。
  • init-job 为一次性任务,不长期驻留。