LoveChengke
19c2aa07b2
文档站（`docs/` 就是 docfx 项目，发布在 https://lovechengke.github.io/ClassHelper/）： - 四章 + 常见问题 + 完整参考，共 44 页：快速上手（8 页）/ 应用帮助（10 页）/ 管理运维（6 页）/ 开发文档（11 页）。信息架构照 ClassIsland 文档站来： 顶栏分章、左侧章节导航、右侧本页目录、上一页 / 下一页、站内搜索、深色主题跟随系统； - 自定义模板覆盖（`templates/classhelper/`）：把 docfx modern 模板那套英文 UI 文案 （In this article / Improve this doc / Next…）换成中文，补 GitHub 入口与版本徽标， 并加一层只调排版与配色的 `public/main.css`（不动 DOM 结构）； - 站点顶栏的版本徽标取自根 `package.json`（`docs/build.mjs` 用 `--metadata` 注入）， 不在文档里写第二份 —— 否则一定漂； - 404 页单独生成：GitHub Pages 的项目页挂在 `/<仓库名>/` 子路径下，而浏览器是按**被请求的路径** 解析页面里的相对链接的，所以 `<base>` 必须钉到站点根，由 `build.mjs`（本地 `./`）与 workflow（CI 传 `/<仓库名>/`）分别注入； - 构建前清空 `_site`：docfx 只覆盖不清理，删掉或改名的页面会以旧文件留在目录里， 而 Pages 上传的是整个目录。 版本迭代（**每一次 releases，不是每一次提交**）： - 新增 `scripts/version.mjs`。这个仓库里同一个版本号散在 **10 个文件**里（5 份 `package.json`、 `deploy/package.runtime.json`、两个 compose 的镜像 tag、插件 `manifest.yml`、以及插件 C# 里的 `PluginVersion` 常量），手工改必然漏一处，而漏掉的那处**不会报错**，只在某个不常走的分支上 表现为"版本号对不上"。现在收口成两条命令：`pnpm version:check`（逐处比对，不一致 exit 1） 与 `pnpm version:bump patch|minor|major`（一次改写全部 10 处，任何一处匹配不到或匹配到多处 就直接失败退出，不做尽力而为的部分改写）； - `AGENTS.md` 新增 §4.4「版本迭代（每一次 releases，不是每一次提交）」：写清版本号落在哪 10 处、 完整发布命令序列（体检 → 验收 → `dist:all` → 哈希清单 → 推 master → `gh release create` → Linux 包由 CI 合并哈希行），以及"已发布的版本号不要复用"的理由。 其它： - `.github/workflows/docs.yml`：推 master（`docs/**` / `package.json` / workflow 自身有变）即构建并 部署到 Pages；构建带 `--check`，把 docfx 的警告当错误 —— 最常见的警告是"某个 `.md` 没被任何 `toc.yml` 引用"，那种页面有内容但没有侧边栏，属于必须修掉的疏漏； - docs 目录重组后的引用同步：`production` / `mysql` / `linux-deploy` / `winisland-design-tokens` 移到新位置后，AGENTS.md、`deploy/`、`scripts/`、客户端源码注释里的路径引用一并更新； - 文档站只发布 `docs/` 这一棵树，页面里指向树外的相对链接（`../AGENTS.md` 等）改成 GitHub 绝对 URL， 否则上线全是 404； - 图标派生清单补上文档站模板里的 `logo.png` 与 `favicon.png`（`pnpm icons` 一并生成， 仍然只有一个图形源 `build/classhelper.{png,ico}`）； - `docs/_site` 进 `.gitignore` / `.prettierignore` 与 ESLint ignores； - 根脚本补 `version:check` / `version:bump` / `docs:build` / `docs:serve` / `docs:check`。
5.2 KiB
5.2 KiB
title, description
| title | description |
|---|---|
| 数据库管理 | 备份与恢复、导出导入、定时备份，以及 Web 管理端里的「数据库管理」模块。 |
数据库管理
Web 管理端有一个「数据库管理」页（/database，仅管理员可见，后端同样 requireRole('ADMIN')），
把过去要手工做的数据库运维都收进了界面。
它能做什么
| 能力 | 说明 |
|---|---|
| 连接状态检测 | 当前类型（SQLite / MySQL）、连通性与延迟、引擎版本、数据体积、14 张表的行数、连接串（MySQL 密码脱敏） |
| 连接测试 | 对任意目标库试连（切换前的第一步） |
| 一键切换 | SQLite ⇄ MySQL：自动「备份当前库 → 改写 schema provider → 生成客户端 / 建表 → 子进程迁移全部数据 → 改写 .env」，异步任务带步骤进度，失败自动回滚 |
| 备份 / 恢复 | gzip JSON 快照存在 <数据目录>/backups/；手动备份 / 从备份恢复（整库覆盖）/ 删除 |
| 定时备份 | enabled + 间隔小时数 + 保留份数，配置存在 data/database-settings.json；服务端每 10 分钟检查一次到点任务（进程不运行不补跑） |
| 快捷导入导出 | 下载快照 JSON（跨库通用）/ 下载数据库文件（仅 SQLite）/ 导入快照（整库覆盖，base64 上传） |
关键设计：只有一种快照格式
备份、导入导出、跨库迁移共用同一种「JSON 快照」：
- 14 张表按拓扑序导出；
- 恢复时临时关闭外键检查 —— 因为
User.classId → Class与Class.teacherId → User是互相引用的，任何排序都会被其中一侧卡死； - 分批
createMany写入。
因此任意一份备份都能恢复回任意一种受支持的数据库（SQLite 备份可以恢复进 MySQL，反之亦然）。
MySQL 的连接测试 / 建表 / 写入依赖随包内置的 @prisma/adapter-mariadb，不需要额外安装。
三条边界
- 主库只支持 SQLite 与 MySQL。Redis 这类内存键值库 Prisma 不支持建表 / 迁移， 接口层直接 422 拒绝；PostgreSQL 暂未纳入。
- 切换完成后必须重启服务端（安装版跑
restart.cmd，开发模式重跑pnpm dev:server）才会连上新库。 切换失败会自动回滚schema.prisma，.env只在数据全部迁移成功后才改写。 - 目标库必须为空（有表就拒绝）。
安装包体积因此从约 34MB 涨到约 62MB：切换需要随包带上 prisma CLI 与 TypeScript 编译器 （Prisma 7 的生成器产出
.ts源码，切换后要在目标机上编译进dist）。
命令行 / SSH 场景的备份
Web 界面适合日常；服务器上更适合用命令。Linux 安装形态有一套现成的：
sudo classhelper backup # 备份配置 + 数据库
sudo classhelper backup --note "升级前" --keep 7
sudo classhelper backup list
sudo classhelper backup restore 20261005-033000 # 用某个备份覆盖当前配置与数据（会先停服务）
sudo classhelper backup schedule daily # 每天 03:30 自动备份（systemd timer，保留 7 份）
sudo classhelper backup schedule off
备份落在 /var/backups/classhelper/<时间戳>[-说明]/：config.env + classhelper.db + meta.json，
目录权限 700、文件 600。
- SQLite 用
VACUUM INTO做一致性快照 —— 服务在跑也安全，比直接cp可靠得多； - MySQL 用
mysqldump --single-transaction，密码经环境变量传给子进程，不进 argv； restore前会先自动备份现状；恢复的对象是配置与数据，不是程序。
其它形态怎么备份
| 形态 | 备份 | 恢复 |
|---|---|---|
| Windows 安装包 | 停服务后复制 data\ 目录（里面有 classhelper.db） |
替换后启动 |
| Linux | classhelper backup（见上） |
classhelper backup restore |
| Docker | 备份挂载出来的数据卷 | 还原数据卷 |
| MySQL（任意形态） | mysqldump -u classhelper -p classhelper > backup.sql |
mysql … < backup.sql |
建议：每日自动备份 + 保留 7 份，并且定期真的恢复一次验证备份可用。
变更
JWT_SECRET会让所有用户重新登录，无必要时不要换。 Linux 上换用sudo classhelper key rotate。