Files
OJ2/docs/deploy.md
yuetsh a8408c0bb5 docs: 文档整理,CLAUDE.md 瘦身一半,删掉重写期已完成的 22 份阶段产物
CLAUDE.md 从 490 行降到 228 行:只留日常要当场记住的约束,展开拆成五份专题
文档 —— docs/deploy.md(部署与备份恢复)、database.md(迁移执行器、基线、
drizzle-kit 的坑)、timezone.md(时区口径与那次成就订正)、contract.md
(出参不 parse 的四次故障)、ast-rules.md(AST 规则与 C++ 的调用形态)。

删掉的是阶段 0–5 那批一次性产物:4 份实施计划、10 份评审/核验/修复报告、
endpoint-inventory.md(110 端点是 2026-08 的快照,现在 363 条路由)、
docs/spikes/ 的 spike 与提取脚本(结论早已落进代码)。phase5 切换手册删之前
先把仍然有效的部分提炼进 docs/deploy.md:拓扑、deploy.sh、部署后验证清单、
NPM 那两个不能关的开关、pg_dumpall 恢复的两个坑、镜像体积;演练报告与回滚
两节随旧栈下线一并作废。

两份设计文档保留,补上状态行说明它们是「当初为什么这么定」而不是现状。

apps/web/CLAUDE.md 顺手订正过期内容:PUBLIC_OJ_URL / PUBLIC_WS_URL 两个变量
早已不存在(baseURL 写死 /api,dev 走 vite proxy、线上由 Caddy 同源伺服),
store 与 composable 清单补齐到与目录一致。

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-16 08:03:26 -06:00

6.5 KiB
Raw Blame History

部署

现行部署形态与操作。具体变量怎么填看 docker/.env.example,那份注释是权威; 这里只写它装不下的东西:两个站点的拓扑、上线的两条路、出事时的退路。

拓扑

服务器(oj.xuyue.cc 机房
compose docker/compose.debian.yml docker/compose.school.yml
env docker/.env docker/.env.school
本机 postgres旧栈起的原地没动 没有,连服务器那台的 5445
Redis / 判题沙箱 各自一套 各自一套
对外 NPM 反代 → WEB_PORT http 直连 IP端口 81

两个站点共用一个数据库所以结构变更对两边同时生效但判题队列BullMQ 在本地 Redis和 WebSocket 推送(本地 pub/sub是每站独立的 —— 学生在哪边提交就在哪边判、 推送也只推得到连在本站的人。这和旧栈 Dramatiq + Channels 的拓扑一致,不是回归。

机房那套 COOKIE_SECURE=false:走 http 直连 IPSecure 的 Cookie 浏览器不回传, 表现是「登录成功又立刻变未登录」。

三种数据形态

compose.debian.yml 靠 env 切换,判据是 DB_HOST

  • 外接数据(线上就是这个):设 DATA_DIR / DB_HOST / REDIS_HOST 沿用已经在跑的 postgres 和 redis本栈只起 api / worker / web / judge。
  • 自带数据(本机、演练):那几个变量留空,起栈时加 --profile local-data
  • 试跑形态额外要 WEB_PORTJUDGE_STATE_DIR(两个判题机不能共用运行目录)。

⚠️ DATA_DIR 默认值 ../dataOJ2/data,不是部署目录的 data/ 沿用旧数据却忘了设它,会静默挂上一堆空目录:空库、没测试点、题面图片 404 而且不报错。这是整个部署里唯一会静默走歪的地方,deploy.sh 专门为它设了一道自检。

上线

服务器push 就部署

.github/workflows/deploy.yml —— 在 runner 上编好产物、rsync 到服务器、在服务器上 跑 docker/deploy.sh --prebuilt。触发的是 push 到 github 这个 remote origingit.xuyue.cc,平时那次 push 不触发):

git push github main

产物在 runner 上编是因为服务器性能差(首次构建约 5 分钟,光前端就 160s服务器自己编的能力没有砍掉:不带 --prebuilt 就是原来的行为,只要有 docker 就能手动部署,不依赖 CI。

手工部署(机房、或 CI 不可用时)

cd /root/OJDeploy/OJ2
docker/deploy.sh              # 自检 → 构建 → 迁移 → 起栈 → 冒烟
docker/deploy.sh --check      # 只自检,只读,不动任何容器
docker/deploy.sh --no-build   # 只改了 env / compose 时跳过构建

代码怎么上到服务器不归它管rsync 命令在脚本头部注释里)。

脚本起栈前有一串自检,每一条都是真撞到过的compose 版本 ≥ 2.20、DATA_DIR 有没有生效、库指向和形态是否自洽、判题机运行目录有没有和旧栈分开、外接的 postgres / redis 是否活着。起完再跑四条冒烟,题目数是 0 也中止 —— 那意味着连错库了。

迁移在起栈之前跑

deploy.sh 在「构建镜像」之后、「起栈」之前跑 oj2-api migrate,失败就中止部署 (旧容器原样还在跑)。所以不需要给 GitHub 配数据库凭据,也不用把生产库对外开放。

破坏性迁移(DROP TABLE / DROP COLUMN / ALTER COLUMN ... TYPE / TRUNCATE 会让部署停在这一步并退出 4放行的三条路见 docs/database.md

部署后验证

命令能测的(服务器 WEB_PORT,机房 81

BASE=http://localhost:8080
curl -s -o /dev/null -w '首页          %{http_code}\n' $BASE/
curl -s -o /dev/null -w '站点配置      %{http_code}\n' $BASE/api/site
curl -s -o /dev/null -w '题目列表      %{http_code}\n' $BASE/api/problems
curl -s -o /dev/null -w '未登录进后台  %{http_code}\n' $BASE/api/admin/dashboard   # 期望 401

两个失败模式的症状别搞混:

  • 题目列表 "total":0 → 连错库了(DB_HOST 没设,或误加了 --profile local-data 起了个自带的空 postgres。立刻停下来查。
  • 库是对的,但判题全错、题面图片 404DATA_DIR 指错了。

命令测不到、必须手点的:登录 → 提交一道题看结果实时刷出来(这一步同时验证 WebSocket→ 后台判题机列表在线 → 后台题目列表翻页 → 带图片的题面能显示。 机房额外确认一条:登录之后刷新还是登录态。

NPM 反代

一次性配好的,只有改了 WEB_PORT 才要回去动端口。另外两项别关:

关了会怎样
Websockets Support 页面一切正常,唯独学生盯着的「判题中…」永远不动
client_max_body_size 200M 后台上传测试用例压缩包失败(和 Caddyfile 的 200MiB 对齐)
SSL 签证书 COOKIE_SECURE=true 依赖 https

备份与灾难恢复

docker/backup-db.shpg_dumpall 全量(所有库 + 所有角色),带校验和保留策略。 恢复时有两条只在现场才暴露的坑:

  1. pg_dumpall 的备份会覆盖数据库口令。 里面带 ALTER ROLE onlinejudge ... PASSWORD 恢复完 compose 里的 POSTGRES_PASSWORD 就对不上了,报的是 password authentication failed,看起来和恢复毫不相干。恢复后要么把 POSTGRES_PASSWORD 改成备份当时的口令,要么手动 ALTER ROLE
  2. 恢复前必须先停应用。 应用连着库时 dump 里的 DROP DATABASE 会失败 database "onlinejudge" is being accessed by other users),接下来就是满屏主键冲突。 先停 oj-api / oj-worker再恢复。

旧栈已经不可逆地下线0002_drop_django_leftovers 删掉了 Django 的框架表并已在 生产库执行完毕),所以「停新栈起旧栈」不再是退路,唯一退路是从数据库备份恢复

镜像体积

镜像 体积
oj2-api 487MB 其中 clang-formatapt269MB、二进制 112MB、基底 79MB、ruff 28MB
oj2-web 75MB

一半以上是 clang-format 拖进来的 LLVMlibLLVM.so 一个就 124MB。设计文档当初写的 「降至数十 MB」没做到就是漏算了它。想再瘦只有一条路换成 PyPI 那个静态链接的 clang-format 独立二进制,能砍掉约 265MB。没做 —— 镜像是各站点本地构建的、不走镜像仓库, 磁盘不是瓶颈。