Files
OJ2/docs/deploy.md
T
xuyueandClaude Opus 5.5 793848b06f
Deploy / deploy (push) Canceled after 0s
refactor(登录): 登录态从 Cookie 换成 access token + refresh token
- access token 是 15 分钟的 JWT,走 Authorization: Bearer;refresh token 7 天,每次换都轮换
- 退出登录、改密码、禁用账号仍然立刻生效:每个请求核对 Redis 会话和库里新加的 user.token_version
- 在服务器后台改密码 / 禁用,机房那边登着的也会一起下线(原来两边 Redis 分开,管不到)
- WebSocket 握手借子协议带 token;JWT 密钥存在本站 Redis,部署不用加配置
- 去掉 COOKIE_SECURE;上线后所有人要重新登录一次

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-20 19:22:52 +08:00

12 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 生成的新口令重建, move-db-into-oj2.sh 不接受弱口令。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 上编好产物、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-2 是本机构建的(上游 JudgeServer 停更在 2024-04,官方镜像的编译器停在 gcc-13)。新机器或换镜像之后,先把镜像 load 进去 再部署:

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

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

把库搬进 OJ2(一次性,顺带 PostgreSQL 16 → 18、Redis 7 → 8)

docker/move-db-into-oj2.sh 把服务器上旧栈 compose 起的 postgres / redis 换成本栈的。 大版本不能原地换镜像(18 读不了 16 的目录),所以走「备份 → 新目录起 18 → 恢复」。 本机用 10-13 的生产备份搭了一套和线上一样的「之前」状态完整演练过:13 万条提交恢复 5 秒,行数一致,登录态保住,提交照常判题,机房那样从外面连 5445 新口令能进、旧口令被拒。

挑没课的时候做,两个站点共用这个库,中间两边都用不了(镜像在停机前编好,真正停机 的那段不到一分钟)。

# 0. 代码先推上去。CI 会照常 rsync,然后在 deploy.sh 自检停下(数据目录还不是 18)、
#    工作流判红 —— 这是预期的,容器一个没动,旧栈照常服务。

# 1. 机房:停应用
docker compose -f docker/compose.school.yml --env-file docker/.env.school stop oj-api oj-worker

# 2. 服务器:docker/.env 的 POSTGRES_PASSWORD 换成新生成的强口令(openssl rand -hex 32)

# 3. 服务器:搬家(CI 已经把产物 rsync 过来了,所以用 --prebuilt)
cd /root/OJDeploy/OJ2
docker/move-db-into-oj2.sh --prebuilt

# 4. 机房:docker/.env.school 的 POSTGRES_PASSWORD 改成同一个新值,然后(顺带换上 Redis 8)
docker compose -f docker/compose.school.yml --env-file docker/.env.school up -d --build

脚本每一步都有自检:机房没停(还有客户端连着旧库)会报出 IP 并中止,口令弱也中止, 恢复后行数对不上、新口令从网络登不上也中止。做完按「部署后验证」两边各点一遍。

之后:/root/OJDeploy/docker-compose.yml 里的 oj-postgres / oj-redis 删掉(留着的话 哪天有人 up 一下会和本栈抢端口);docker/.env 里的 DB_HOST / DB_PORT / REDIS_HOST / REDIS_PORT 也删掉(deploy.sh 会提醒)。

恢复时为什么剥掉 dump 里的口令:旧库的口令是 md5 哈希存的,dump 原样带着;而 18 的 镜像新建的库 pg_hba.conf 只认 scram-sha-256,md5 存的口令永远验不过。容器里 docker exec psql 走本地 socket 是 trust,一切看着正常,只有 api 和机房从网络连进来才报 password authentication failed —— 演练时就是这么发现的。剥掉之后库里留的是初始化时按 POSTGRES_PASSWORD 存的 SCRAM 哈希。

中途失败:停旧容器之前失败的,docker start oj-api oj-worker 就回去了。之后失败的, 旧库目录 $DATA_DIR/postgres 一个字节没动:

docker rm -f oj-postgres oj-redis                                     # 本栈的 18 / 8
docker compose -f /root/OJDeploy/docker-compose.yml up -d oj-postgres oj-redis   # 旧的 16 / 7
# docker/.env 的 POSTGRES_PASSWORD 改回旧口令、DB_HOST 那四个变量填回去,
# 代码退回搬家之前那个提交再 docker/deploy.sh

搬家之后写进 18 的数据回退时会丢。跑稳一两周再删 $DATA_DIR/postgres。

镜像体积

镜像 体积
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。没做 —— 镜像是各站点本地构建的、不走镜像仓库, 磁盘不是瓶颈。