Files
OJ2/docs/deploy.md
T
xuyueandClaude Opus 5.5 b046af4ba0
Deploy / deploy (push) Canceled after 0s
chore(部署): push 后先过检查再部署;判题机重启那几秒交的题不再变成系统错误;worker 挂了看得出来
按外部分析报告(reports/analysis)挑出来做的几条:
- CI 在编完前端之后跑 `bunx vp run verify`,有一项不过就不部署(必须排在编前端之后:
  前端类型检查要的 auto-imports.d.ts / components.d.ts 是 vite build 时才生成的)
- 连不上判题机(连接被拒、解析不到、被重置)时,正式判题等 2/5/10 秒重试,不再当场记成
  系统错误;超时、判题机回错、页面上的运行和自测不重试
- worker 每 10 秒刷一次「还活着」,compose 加 `oj2-api healthcheck --worker`,deploy.sh 起栈后
  也等 worker 健康(docker 不会因 unhealthy 自动重启,只是看得见、部署时拦得住)
- 三套 compose 的容器日志限 10MB × 3
- `/public/%` 这类畸形编码回 404 而不是 500;找不到的接口回统一的 JSON 错误
- 删掉没人用的「停用判题机」接口,契约不再给 task_number / is_disabled(列留在库里)
- 删掉腐化的 apps/web/tests/submitButtonState.test.ts;契约包 zod 范围对齐到 ^4.6.6
- 修几处和实际对不上的注释与文档(表数、编译并发、AST 语言数、deploy.sh 流程、校验处数)

⚠️ 改了 compose 的日志配置,这次部署会把 postgres / redis / 判题机也重建一遍,各停几秒

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-02 20:59:19 +08:00

10 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
库 本栈的 oj-postgres(PostgreSQL 18) 没有,连服务器那台的 5445
Redis / 判题沙箱 各自一套 各自一套
对外 NPM 反代 → WEB_PORT http 直连 IP,端口 81

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

登录态是 access token + refresh token(见 apps/api/src/auth/session.ts),会话存在 本站的 Redis 里,所以在一个站点登录,到另一个站点还要再登一次。JWT 的签名密钥也存在 本站 Redis(auth:jwt-secret,首次启动自动生成),部署不用配;删掉它再重启 api 等于让 本站所有人重新登录。改密码、禁用账号走库里的 user.token_version,两个站点同时生效。

全部容器都归 OJ2

服务器上 postgres / redis / 判题沙箱 / api / worker / web 全由 compose.debian.yml 起, 升级哪个都只改仓库里的文件。

2026-10 以前库和 redis 是旧栈那份 /root/OJDeploy/docker-compose.yml 起的,OJ2 通过 DB_HOST / REDIS_HOST 外接过去,升个版本就得去服务器上改那份文件。这种「外接」形态 已经删掉了,搬家见下面「把库搬进 OJ2」。

⚠️ DATA_DIR 默认值 ../data 是 OJ2/data,不是部署目录的 data/。 忘了设它,postgres 会在空目录上初始化一个空库,测试点和题面图片也都不在, 而且不报错。这是整个部署里唯一会静默走歪的地方,deploy.sh 专门为它设了自检 ($DATA_DIR/postgresql/18/docker 必须已经是一个库)。

口令

会话存在 Redis 里(session:<token> → 用户 id),谁能连上它,谁就能写一条会话 冒充任意用户,包括超管。所以服务器那台的 Redis 必须带口令(REDIS_PASSWORD, compose 里 :? 强制要求),端口也只发布在 127.0.0.1。2026-09-27 以前它发布在 0.0.0.0:5446、不带口令,从公网直接 PING 得通(实测过)。

数据库口令同理:onlinejudge 是超级用户,5445 对公网开着(机房要连),2026-10 以前 口令就是默认的 onlinejudge。搬进 OJ2 时用 openssl rand -hex 32 生成的新口令重建。POSTGRES_PASSWORD 只在库初始化时生效一次,以后要换:

docker exec -it oj-postgres psql -U onlinejudge -d postgres -c '\password onlinejudge'
# 再改 docker/.env 和机房 docker/.env.school 的 POSTGRES_PASSWORD,两边都重新 up -d

机房那台的 oj-redis 不发布端口、只在 compose 网络里,不需要口令。

上线

服务器:push 就部署

.github/workflows/deploy.yml —— 在 runner 上编好产物、跑一遍 bunx vp run verify (格式、lint、前后端类型检查、路由遮蔽、AST 节点,不过就不部署)、rsync 到服务器、 在服务器上跑 docker/deploy.sh --prebuilt。触发的是 push 到 github 这个 remote (origin 是 git.xuyue.cc,它会镜像到 github,所以平时 push origin 通常几秒后 也就部署了,偶尔不跟、要 git ls-remote github 核实。Gitea 自己不跑这份工作流 —— 没有 .gitea/workflows 时它的 Actions 会退回来读这份工作流,所以 job 上卡了 github.server_url == 'https://github.com',在 Gitea 上直接跳过):

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 命令在脚本头部注释里)。

脚本起栈前有一串自检,每一条都是真撞到过的:DATA_DIR 有没有生效、数据目录是不是 一个 18 的库、判题镜像在不在。起完再跑四条冒烟,题目数是 0 也中止 —— 那意味着连错库了。

判题镜像是自建的,不在 registry 上

compose.*.yml 里的 oj2-judge-3 是本机构建的(go-judge 的二进制 + 我们要的 gcc / python)。新机器或换镜像之后,先把镜像 load 进去再部署:

# 本机
docker/judge/build.sh --save
scp dist/oj2-judge-3.tar root@服务器:/root/OJDeploy/
# 服务器 / 机房各来一次(两个站点各有各的判题沙箱)
docker load -i /root/OJDeploy/oj2-judge-3.tar

判题机容器是 privileged 的(go-judge 要自己建 cgroup),理由见 docker/judge/README.md。

忘了这一步,deploy.sh 起栈时会去 pull 一个不存在的镜像并失败(响亮地失败, 不会静默降级)。构建、回滚和工具链版本表见 docker/judge/README.md。

迁移在起栈之前跑

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 → 连错库了(DATA_DIR 指到了一个新初始化的空库)。 立刻停下来查。
  • 库是对的,但判题全错、题面图片 404 → DATA_DIR 指错了。

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

NPM 反代

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

项 值 关了会怎样
Websockets Support 开 页面一切正常,唯独学生盯着的「判题中…」永远不动
client_max_body_size 200M 后台上传测试用例压缩包失败(和 Caddyfile 的 200MiB 对齐)
SSL 签证书 登录 token 明文走公网;浏览器也只在 https 下给 navigator.locks,几个标签页换 token 会撞车(有宽限期兜着,但别依赖它)

备份与灾难恢复

docker/backup-db.sh 走 pg_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 的框架表并已在 生产库执行完毕),所以「停新栈起旧栈」不再是退路,唯一退路是从数据库备份恢复。

把线上数据拉到本机

docker/pull-prod.sh(在本机跑)经 ssh debian 只导 onlinejudge 一个库(pg_dump -Fc, 不带角色,所以不会踩上面的坑 1),先灌进 onlinejudge_incoming、对过行数再换名(不用停 dev, 避开坑 2),换下来的旧库留作 onlinejudge_prev。--files 顺带同步测试点、题面图片、头像。 对服务器只读;拉完本机的账号口令都是线上的。用法和刻意的做法在脚本头部。

把库搬进 OJ2(2026-10-13,已完成)

服务器上的 postgres / redis 原来由旧栈的 compose 起,那次搬进了本栈,顺带 PostgreSQL 16 → 18、 Redis 7 → 8(一次性脚本 docker/move-db-into-oj2.sh 用完已删,要看去 git 历史)。 留下的坑只有一个,恢复搬家之前(16 时代)的备份时会踩:

恢复时要剥掉 dump 里的口令(上面坑 1 的加重版):16 的库口令是 md5 哈希存的,dump 原样带着;而 18 的 镜像新建的库 pg_hba.conf 只认 scram-sha-256,md5 存的口令永远验不过。容器里 docker exec psql 走本地 socket 是 trust,一切看着正常,只有 api 和机房从网络连进来才报 password authentication failed。剥掉之后库里留的是初始化时按 POSTGRES_PASSWORD 存的 SCRAM 哈希。

服务器上的 $DATA_DIR/postgres(16 的老库目录)如果还在,可以删了。

镜像体积

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

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