Files
ClassHelper/docs/get-started/requirements.md
T

4.2 KiB
Raw Blame History

title, description
title description
系统要求 ClassHelper 服务端、Web 管理端、桌面客户端的运行环境与网络要求。

系统要求

服务端

服务端的安装包自带 Node 运行时,目标机器不需要另外装 Node.js,也不需要数据库软件 (默认用内嵌的 SQLite)。

项目 要求
操作系统 Windows 10 / 11 / Server 2016+(x64);Linux(glibc 2.28+,见下);Docker
内存 512 MB 起步,2 GB 以上更稳(Node + SQLite 常驻约 120–200 MB)
磁盘 程序约 340 MB(免安装目录)/ 安装后约 400 MB;数据按班级量增长,通常几十 MB
CPU 任意 x64;不需要独显

Linux 的 glibc 要求:内置的 Node 官方 linux-x64 构建要求 glibc ≥ 2.28。 CentOS 7 是 2.17,一键安装器会检测并自动换成 -glibc-217 变体(尽力而为,未做长期验证)。 判据:

ldd --version | head -1

外网:服务端只在「检查更新」时访问 GitHub,且失败是设计内的结果(返回"查不到",不报错)。 内网机器可以完全不连通外网。

Web 管理端

不需要安装,用浏览器打开服务端地址即可。

项目 要求
浏览器 Chrome / Edge 100+、Firefox 100+、Safari 15+(要支持 CSS 容器查询)
屏幕 桌面 1280×720 以上;手机(≤768px)有一套独立的抽屉式布局,同样可用
安装 PWA 手机 / 桌面 Chrome 里「添加到主屏幕」可当 App 用(需要 HTTPS 或 localhost)

桌面客户端(ClassHelper 班级端 / 教室机器)

项目 要求
操作系统 Windows 10 / 11(x64)
内存 4 GB 以上(Electron 常驻约 250–400 MB)
磁盘 安装后约 330 MB
显卡 有 D3D11 即可;希沃一体机、老显卡、虚拟机都做过兼容(没有裁剪 GPU 回退组件)
触摸屏 支持,会自动进入触摸模式(希沃白板等)

客户端只有 Windows 版。Linux / macOS 上目前只能用 Web 管理端。

网络

三端的通信都指向服务端的 HTTP 端口(默认 4000),其中:

  • REST 接口:/api/*
  • 实时推送(Socket.IO):/socket.io/
  • Web 管理端静态资源:/(由服务端托管)
场景 要做什么
只在服务器本机用 什么都不用做,http://127.0.0.1:4000
教室机器 / 老师电脑也要用 客户端与管理端填服务器的局域网 IP(如 http://192.168.1.10:4000),防火墙放行 4000
公网访问 前面加 Nginx / Caddy 反代并启用 HTTPS,见生产部署指南

别用代理。自测时用 curl.exe --noproxy '*',PowerShell 用 -NoProxy; 教室机器上如果开了系统代理,填服务端地址后可能拿到代理返回的 404。请检查系统代理绕过列表是否包含服务端的局域网地址。

卸载 / 重置

  • 服务端:开始菜单 → 卸载。卸载会保留数据库(data 目录改名为 data.backup)。
  • 客户端:从托盘退出后卸载;重置配置删 %APPDATA%\class-helper(或客户端「关于」页显示的数据目录)。

下一步:安装服务端。