功能级准入改为「权限键」,`requireRole` 退成默认模板。 权限组 - 权限目录(39 键:键 / 中文名 / 分类 / 默认角色)收口到 shared,路由挂 requirePermission / requireAnyPermission - 有效权限每请求实时算,改完分组立刻生效:ADMIN 全集且 permission:manage、system:manage 不可剥夺; CLASS_DEVICE 空集(不受分组影响);有分组 = 并集(因此也能用来**收回**权限);无分组 = 角色默认模板 - 新增「权限组」页:组增删改、成员分配、生效权限预览 - 班级维度的科目规则(assertCanManageSubjectContent)故意不可被权限组覆盖 客户端设备(ClassHelper 桌面端) - 设备身份是 deviceKey(首次启动生成的 UUID,saveConfig 拒绝改写、退出登录也保留) - 心跳走「DB 记状态 + 客户端定时拉」,不引入新的长连接:30 秒一次,在线窗口 90 秒 - 远控命令 shutdown / restart / logoff / lock:服务端有效期 10 分钟,客户端弹默认选中「取消」的对话框、 60 秒未确认按取消处理,执行后必须回执(重复回执幂等),同一台机器同一条命令只弹一次 - 新增「客户端设备」页:版本一览、一键推送更新、下发远控 客户端安装包由服务端下载并缓存(教室机常常没有外网,浏览器也受 CSP 限制) - POST /api/update/client/fetch 由服务端下载到 data/client-releases/<版本>/ 并登记 sha256 + size - 自动安装三条护栏:没有 sha256 就拒收、必须等到非上课且主窗口隐藏满 5 分钟、冒烟模式永不安装 大模型助手:只解析、不落库 - POST /api/ai/interpret 返回**待确认**的结构化动作(建作业 / 发通知 / 叫人), 真正落库仍调既有端点 —— 权限断言、上课时段紧急通知保护、ClassIsland 推送全部自动复用 - 模型给的 params 用与手动入口**同一份** zod 再校验(模型输出不可信) - API Key 走 AES-256-GCM(密钥由 JWT_SECRET 经 scrypt 派生)加密存 AppSetting,只进不出 - provider=mock 是离线确定性解析,自动化验收一律用它;每次解析写一条 AiAudit(不含密钥) 系统与运维 - 开发者模式(服务端内存缓存开关,热路径不查库;开启后 500 才附 error.stack)、运行诊断(绝不回传密钥) - 开机自启动运行期可改:Windows 改 HKCU\...\Run、Linux systemctl enable/disable, **非安装形态一律返回 supported:false**,不往开发机的注册表里写自启项 - 服务端侧栏折叠只用 CSS 收拢(不重建 DOM),关怀模式只放大字号与控件、不动任何几何令牌 客户端 - 崩溃自愈:渲染进程挂掉 / 超 10 秒无响应先静默重建主窗口(10 分钟最多 3 次), 未捕获异常只在「没在上课、没人看着」时才重启进程;冒烟模式绝不重启(会杀掉验证实例) - 上线补弹离线期间收到的消息只做一次:起点只在「可达 → 不可达」的边界写,恢复时取最近 5 条按时间升序推 发布内容批量 - POST /notifications/bulk、POST /homeworks/bulk:**单班失败不影响整批**,逐班返回结果 - 作业的科目名跨班**按名匹配**已有课程,找不到就整班记失败,绝不自动建课 (自动建课会把创建者写成任课老师,等于越权改任教关系) - 通知与作业同口径按「所属日期」归档,新增 /notifications/days 与 /notifications/creators BREAKING CHANGE: 能不能做某件事不再看角色名,而是看权限键(GET /api/permissions/me)。 未分组的账号按角色默认模板生效,行为与 1.2.0 一致;分组之后生效集合只由组的并集决定。 服务端首次启动会自动应用 1 个数据库迁移(权限组 3 表 / AppSetting / 客户端设备·命令·安装包 / AiAudit / Notification.assignDate / User.careMode,历史通知按本地日期回填),升级前请先备份。
6.6 KiB
title, description
| title | description |
|---|---|
| 安装服务端 | 用 Windows 安装包、Linux 一键脚本、Docker 或源码把 ClassHelper 服务端跑起来。 |
安装服务端
服务端是整个系统的中心:它存数据、发实时推送,并且顺带托管 Web 管理端(所以老师那一端不用单独装东西)。
四种装法按场景选,任选一种即可:
| 方式 | 适合 | 一句话 |
|---|---|---|
| Windows 安装包 | 学校机房、教师办公电脑、单机即完整系统 | 双击 exe,装完自动启动 |
| Linux 一键安装 | 学校已有 Linux 服务器 | 一条命令,带 systemd 与运维命令 |
| Docker | 云服务器、想跟别的服务共用一台机器 | docker compose up -d |
| 源码跑 | 想改代码、想先看看它长什么样 | pnpm dev |
Windows 安装包
生成安装包
安装包不入库(体积大),从 Releases 直接下载
ClassHelper 服务端-<版本>-x64-setup.exe 即可。要自己打:
pnpm dist:server # 首次会执行一次 npm install(约 2 分钟)
pnpm dist:server -- --reuse-deps # 迭代打包:复用已装依赖,跳过 npm install
产物:
| 路径 | 说明 |
|---|---|
releases/server/<版本>/安装包/ClassHelper 服务端-<版本>-x64-setup.exe |
安装程序(约 62 MB,NSIS) |
交付产物只有安装程序。组装出来的那份运行时(内置 Node + 依赖 + 后端与 Web 产物,约 335 MB) 只是打安装包的中间物,落在
.cache/server-staging/<版本>/下,打完脚本就删掉了 —— 想留一份可直接双击运行的副本,见本文末「不用安装程序的手动部署」。
包内自带 Node 运行时、后端产物、Web 管理端产物、生产依赖、迁移 SQL、随机 JWT_SECRET 的 .env
与启停脚本。目标机器不需要预先安装 Node.js。
安装与启动
双击安装程序即可,不需要管理员权限(当前用户级安装)。
- 安装目录:
%LOCALAPPDATA%\Programs\ClassHelperServer - 静默安装:
"ClassHelper 服务端-<版本>-x64-setup.exe" /S - 开始菜单:启动服务 / 停止服务 / 重启服务 / 打开管理端 / 使用说明 / 卸载
- 自动加入当前用户开机自启
装完服务会自动启动并完成首次初始化:数据库为空则执行随包迁移建表 → 创建管理员账号 →
http://127.0.0.1:4000/ 就是 Web 管理端。
常用脚本(都在安装目录里):
start.cmd :: 启动并等待就绪(已在运行则直接返回)
stop.cmd :: 按 PID 精确停止
restart.cmd :: 重启
status.cmd :: 查看状态与 HTTP 探针结果
机房主机这种无人值守的机器,建议以管理员身份跑一次 install-service.cmd,
把服务注册成开机启动的计划任务(比注册表 Run 更稳):
install-service.cmd :: schtasks /Create /SC ONSTART /RL HIGHEST
uninstall-service.cmd :: 删除计划任务
安装目录结构与配置见生产部署指南; 安装程序里的默认管理员口令第一次登录后必须改掉。
Linux 一键安装
从 Release 下载 classhelper-server-linux-x64-<版本>.tar.gz(以及旁边的 .sha256),连同
install.sh 一起拷到服务器:
scp releases/server/<版本>/linux-x64/classhelper-server-linux-x64-*.tar.gz \
install.sh verify-linux.sh root@<主机>:/tmp/
ssh root@<主机> 'bash /tmp/install.sh --check' # 先体检,不改任何东西
ssh root@<主机> "printf '%s\n' '<管理员密码>' | bash /tmp/install.sh --yes --admin-password-stdin \
--package /tmp/classhelper-server-linux-x64-*.tar.gz"
安装器会装好内置 Node、把程序放到 /opt/classhelper、写好 systemd 单元、
把 classhelper 运维命令软链到 /usr/local/bin/。之后:
classhelper status # 服务状态
classhelper doctor # 一整套自检(配置软链、权限、依赖完整性…)
classhelper backup # 立即备份
classhelper upgrade # 升级到最新 Release(自动校验 sha256)
完整的目录布局、配置项、升级回滚、反向代理与故障排查见 Linux 部署与运维。
Docker
cd deploy
cp .env.example .env # 至少改 JWT_SECRET
docker compose up -d # 默认 SQLite 单容器,数据卷挂在本机
要 MySQL 就用 docker-compose.yml(带一个 MySQL 服务),只想要单容器 SQLite 用
docker-compose.sqlite.yml。细节见生产部署指南。
从源码跑(开发模式)
想改代码或只想先看看,用这条路。需要 Node ≥ 20.19 与 pnpm 11。
pnpm install
cp packages/server/.env.example packages/server/.env # 至少改 JWT_SECRET
pnpm db:generate
pnpm --filter @classhelper/server db:deploy # 应用数据库迁移
pnpm build:shared # 必须先构建 shared,否则后面会 ERR_MODULE_NOT_FOUND
pnpm db:seed # 写演示数据(会清空业务表)
pnpm dev # 后端 4000 + Web 端 5173 一起起
演示账号见 README 的「默认账号与种子数据」; 演示口令只用于本地开发,别带到真实环境。
| 端口 | 用途 |
|---|---|
| 4000 | 后端 REST + Socket.IO + (构建后)Web 管理端静态托管 |
| 5173 | Web 管理端开发服务器(/api、/socket.io 代理到 4000) |
| 5174 | 桌面客户端渲染进程开发服务器 |
改动
packages/shared之后必须pnpm build:shared(或让它跑着 watch)—— 三端都从它的dist导入。
装完之后
打开 http://<服务器地址>:4000/,用管理员账号登录。下一页:
认识 Web 管理端。