76 lines
4.5 KiB
Markdown
76 lines
4.5 KiB
Markdown
|
---
|
|||
|
|
title: 管理运维
|
|||
|
|
description: 部署形态怎么选、备份与恢复、换数据库、升级与回滚，以及上线前要逐项确认的清单。
|
|||
|
|
---
|
|||
|
|
|
|||
|
|
# 管理运维
|
|||
|
|
|
|||
|
|
这一章写给管服务器的人。如果你只是要用它，看[应用帮助](../app/index.md)就够了。
|
|||
|
|
|
|||
|
|
## 先选部署形态
|
|||
|
|
|
|||
|
|
| 形态 | 适合 | 产物 | 详细 |
|
|||
|
|
| ------------------------ | ---------------------------------------- | ----------------------------------- | ----------------------------------- |
|
|||
|
|
| **Windows 安装包** | 学校机房、教师办公电脑（单机即完整系统） | NSIS 安装程序，内置 Node 运行时 | [生产部署指南](production.md) |
|
|||
|
|
| **Linux 原生 + systemd** | 学校已有 Linux 服务器 | 一键安装器 + `classhelper` 运维命令 | [Linux 部署与运维](linux-deploy.md) |
|
|||
|
|
| **Docker** | 云服务器、跟别的服务共用一台机器 | `deploy/docker-compose*.yml` | [生产部署指南](production.md) |
|
|||
|
|
| **手动部署** | 已有 Node 环境、需要自定义 | 免安装目录 | [生产部署指南](production.md) |
|
|||
|
|
|
|||
|
|
一句话的取舍：
|
|||
|
|
|
|||
|
|
- **只有一台 Windows 机器** → 安装包形态，装完就能用，卸载也不留东西。
|
|||
|
|
- **有 Linux 服务器** → 一键安装器，之后所有维护都在 `classhelper` 这一条命令里。
|
|||
|
|
- **要对外提供服务** → Docker 或 Linux + Nginx 反代 + HTTPS（公网部署**必须**有 TLS）。
|
|||
|
|
|
|||
|
|
## 数据库：默认 SQLite，可以换 MySQL
|
|||
|
|
|
|||
|
|
默认用内嵌的 SQLite，**单校规模完全够用**，而且备份就是复制一个文件。
|
|||
|
|
多校区 / 高并发 / 需要多实例再换 MySQL：
|
|||
|
|
|
|||
|
|
- 换法见[切换到 MySQL](mysql.md)（Web 端一键切换 / 命令行手工切换两条路）；
|
|||
|
|
- 备份、导出导入与跨库迁移共用同一种 JSON 快照格式，**任意备份能恢复回任意一种受支持的库**；
|
|||
|
|
- 见[数据库管理](database.md)。
|
|||
|
|
|
|||
|
|
> 主库**只支持 SQLite 与 MySQL**。Redis 是内存键值库，Prisma 不支持它建表 / 迁移，接口层直接拒绝。
|
|||
|
|
|
|||
|
|
## 升级
|
|||
|
|
|
|||
|
|
不同形态的升级方式不一样，共同点是：**升级数据不会丢，但升级前一定先备份**。
|
|||
|
|
|
|||
|
|
| 形态 | 升级方式 |
|
|||
|
|
| ----------- | -------------------------------------------------------------- |
|
|||
|
|
| Windows | 停服务 → 备份 `data` → 跑新版本安装程序（覆盖安装保留 `.env`） |
|
|||
|
|
| Linux | `sudo classhelper upgrade`（自动下载、校验、快照、失败回滚） |
|
|||
|
|
| Docker | `docker compose pull && docker compose up -d` |
|
|||
|
|
| 手动 / 源码 | 替换程序目录，启动时自动补跑数据库迁移 |
|
|||
|
|
|
|||
|
|
完整流程、回滚与注意事项见[更新与升级](upgrade.md)。
|
|||
|
|
|
|||
|
|
## 上线前逐项确认
|
|||
|
|
|
|||
|
|
- [ ] 改掉 `admin` 与教师账号的默认密码；
|
|||
|
|
- [ ] `JWT_SECRET` 是随机值（≥ 48 字节）并妥善保管 —— **换它会让所有人重新登录**；
|
|||
|
|
- [ ] 公网访问走 HTTPS 反向代理（`deploy/nginx.conf` 可直接用）；
|
|||
|
|
- [ ] `CORS_ORIGIN` 收敛到具体域名，不要留 `*`；
|
|||
|
|
- [ ] `TRUST_PROXY=1` 并确认限流按真实 IP 生效（`/api` 响应头有 `RateLimit`）；
|
|||
|
|
- [ ] 反向代理**放行 `/socket.io/` 的 WebSocket 升级**（否则实时推送静默失效）；
|
|||
|
|
- [ ] 数据库账号用最小权限，只授权业务库；
|
|||
|
|
- [ ] 配好定时备份，并且**验证过能恢复**；
|
|||
|
|
- [ ] 关注 `/readyz` 与日志里的 5xx。
|
|||
|
|
|
|||
|
|
## 监控与日志
|
|||
|
|
|
|||
|
|
| 端点 | 用途 |
|
|||
|
|
| ------------- | ---------------------------------------- |
|
|||
|
|
| `/healthz` | 存活探针：进程活着即 200 |
|
|||
|
|
| `/readyz` | 就绪探针：数据库可连才 200，否则 503 |
|
|||
|
|
| `/api/health` | 详情：环境、数据库、已挂载模块、运行时长 |
|
|||
|
|
|
|||
|
|
日志输出到 stdout/stderr；安装包形态由启停脚本重定向到 `logs/server.log`（UTF-8）。
|
|||
|
|
访问日志含方法、路径、状态码与耗时，5xx 记 error、4xx 记 warn。
|
|||
|
|
|
|||
|
|
## 故障排查
|
|||
|
|
|
|||
|
|
常见现象与排查方向列在[生产部署指南](production.md)的最后一节，
|
|||
|
|
以及[常见问题](../faq.md)。Linux 特有的问题（`systemctl` 启动即退出、`EACCES`、
|
|||
|
|
SQLite `database is locked`）在 [Linux 部署与运维](linux-deploy.md) 的故障排查一节。
|