feat: 无头运行器 Docker 镜像
把 runner/ 打包成可直接部署的容器镜像,Linux 服务器 / 群晖 / 云主机上 不用再手动装 Node 与浏览器。 - Dockerfile:node:22-bookworm-slim + 官方 google-chrome-stable。 刻意不用发行版 chromium —— 它不带 H.264/AAC 专有编解码器,课程视频会 一直停在 0 秒;同时满足 preflight.mjs 对 Node 22+ 的硬性要求。 构建期完成 npm ci + npm run build,并实跑一次 headless 验证浏览器可用; CHROME_DEB_URL 构建参数供国内换镜像源。 - docker/entrypoint.sh:建 profile / 日志目录;首参为 sh/node 等时直接 exec 便于排查;无参数且无凭据时降级成 --check,避免容器无意义重启空转。 - docker-compose.yml:挂载 ./.run-profile 与 ./run-logs,shm_size 512m, init: true,日志轮转。restart 用 on-failure:3 而非 always —— 运行器刷完课 会以 0 正常退出,always 会造成「刷完 → 重启 → 再刷完」的热循环。 - .dockerignore:排除 node_modules / .run-profile / run-logs / .env, 凭据不进镜像层。 - .env.example:账号模板;.gitignore 加 !.env.example 白名单。 - .gitattributes:*.sh / Dockerfile / docker-compose.yml 强制 LF —— 带 CRLF 时 shebang 会变成 "/bin/sh\r",容器启动直接 exec format error。 - scripts/check.mjs:静态检查扩展到容器入口,跑 sh -n 并对 CRLF 报错 (Windows 无 sh 时只校验行尾)。29 个文件全绿。 - README:新增「容器(Docker)」小节,含 build / 自检 / run / compose 流程 与 8 条注意事项(卷权限、/dev/shm、沙箱、验证码、时区、退出码与重启策略)。
This commit is contained in:
1 parent
65bf63ea6a
commit
b588b1042f
9 files changed
+319
-4
No files matched your search
@@ -74,6 +74,7 @@ Tampermonkey 用户脚本。支持多课时课程与单视频/音频课程;含
|
||||
| 环境 | 说明 |
|
||||
| --- | --- |
|
||||
| Linux 服务器 | 机房机器、云主机、容器;root 运行、`/dev/shm` 只有 64MB 都自动适配 |
|
||||
| Docker 容器 | 自带官方 Chrome 与 Node 22,镜像内已完成构建;见下方「容器(Docker)」 |
|
||||
| Windows 桌面 | 后台挂着跑;关掉控制台窗口或 `Ctrl+C` 都能让它收尾 |
|
||||
| Windows 服务器核心版 / 无桌面 | 无交互桌面也能跑(Chromium 无头不需要窗口站) |
|
||||
| Windows 服务 / 计划任务 Session 0 | 会检测到 `SESSIONNAME=Services` 强制无头,`headless: false` 被忽略 |
|
||||
@@ -300,6 +301,63 @@ export default {
|
||||
| 计划任务里一起床就退出 | Windows | 运行在 Session 0 没有桌面。运行器检测 `SESSIONNAME=Services` 后强制无头,正常;若仍失败看 `run-logs/headless.log` |
|
||||
| `'鍏?npm' 不是内部或外部命令` / `'01' 不是内部或外部命令` / `'rofile' 不是内部或外部命令` | Windows | 批处理文件里出现了**中文(非 ASCII)字符**或**裸 LF 行尾**。cmd.exe 按当前代码页逐字节读批处理,多字节字符和 LF 都会让行偏移错位,于是把一行拆成几段当命令执行。修法:`.cmd` 只用 ASCII 且必须 CRLF。`npm run check` 会直接拦下这类文件 |
|
||||
|
||||
### 容器(Docker)
|
||||
|
||||
仓库自带 `Dockerfile` / `docker-compose.yml` / `.dockerignore`,镜像里已经装好
|
||||
Node 22 与 **官方 google-chrome-stable**(不是发行版 chromium —— 后者不带 H.264/AAC,
|
||||
课程视频会一直停在 0 秒),并在构建阶段跑完 `npm run build`,所以镜像开箱即用。
|
||||
|
||||
```bash
|
||||
# 1. 构建(首次约 3-5 分钟,主要是下 Chrome 的 deb)
|
||||
docker build -t yun-xue-tang-assistant .
|
||||
|
||||
# 2. 先自检:只读,不登录、不动进度,不需要账号
|
||||
docker run --rm yun-xue-tang-assistant --check
|
||||
|
||||
# 3. 正式刷课(凭据只走环境变量,别写进镜像)
|
||||
docker run -d --name yun-xue-tang \
|
||||
-e YUN_XUE_TANG_USR='你的账号' \
|
||||
-e YUN_XUE_TANG_PWD='你的密码' \
|
||||
-e YUN_XUE_TANG_MAX_COURSES=100 \
|
||||
-v "$PWD/.run-profile:/app/.run-profile" \
|
||||
-v "$PWD/run-logs:/app/run-logs" \
|
||||
--shm-size=512m \
|
||||
--restart on-failure:3 \
|
||||
yun-xue-tang-assistant
|
||||
|
||||
# 4. 看日志 / 收尾
|
||||
docker logs -f yun-xue-tang # 或 tail -f run-logs/headless.log
|
||||
docker stop yun-xue-tang # SIGTERM → 暂停视频 → 停批量 → 关浏览器
|
||||
```
|
||||
|
||||
用 `docker compose` 更省事(账号写在 `.env` 里,`.env` 已在 `.gitignore`):
|
||||
|
||||
```bash
|
||||
cp .env.example .env # 填 YUN_XUE_TANG_USR / YUN_XUE_TANG_PWD
|
||||
docker compose build
|
||||
docker compose run --rm yun-xue-tang --check # 自检
|
||||
docker compose run --rm yun-xue-tang --max-courses 3 # 只刷 3 门,跑完就退
|
||||
docker compose up -d # 常驻
|
||||
docker compose logs -f
|
||||
docker compose down
|
||||
```
|
||||
|
||||
需要注意的几点:
|
||||
|
||||
| 事项 | 说明 |
|
||||
| --- | --- |
|
||||
| 挂载目录 | `/app/.run-profile`(登录 cookie,**别提交**)与 `/app/run-logs`(日志)要挂出来,否则重建容器就等于重登 + 丢日志 |
|
||||
| 卷权限 | 容器内以 root 跑。用绑定挂载时宿主机目录会被写成 root 所有;想用自己的 UID 就在 compose 里加 `user: "${UID}:${GID}"`(运行器会据此自动降级沙箱参数) |
|
||||
| `/dev/shm` | 容器默认只有 64MB,`shm_size: 512m` 更稳(运行器本身也加了 `--disable-dev-shm-usage` 兜底) |
|
||||
| 沙箱 | 容器内 Chrome 沙箱受限,运行器检测到 root/容器会自动补 `--no-sandbox --disable-setuid-sandbox`,不用手写 |
|
||||
| 终端面板 | 面板要求 stdout 是 TTY,后台容器里自动关闭、退回逐行日志。想在 `docker run -it` 里看面板:`docker run -it -e YUN_XUE_TANG_TUI=1 …` |
|
||||
| 验证码 | 首个登录若被要求验证码/滑块,无头环境无法完成:先在宿主机用 `npm run headless -- --headless 0` 有界面登录一次,再把宿主机 `.run-profile` 目录挂进容器复用 cookie |
|
||||
| 时区 | 镜像默认 `TZ=Asia/Shanghai`,日志时间戳与之对齐;要改就用 `-e TZ=...` |
|
||||
| 退出码与重启策略 | 与裸机一致:`0` 正常收尾、`1` 无进展、`2` 环境/参数问题、`3` 连续登录失败。**别用 `--restart always / unless-stopped`**:它们不看退出码,刷完课(`0`)会自动重启再来一轮,形成热循环;用 `--restart on-failure:3` 这类只在失败时重试的策略 |
|
||||
| 缺凭据 | 入口脚本在**没传参数且没填凭据**时自动降级成 `--check`,避免容器无意义重启空转 |
|
||||
| Chrome 下载失败 | 国内机器常从 dl.google.com 下不动,用构建参数换镜像源:`docker build --build-arg CHROME_DEB_URL=https://你的镜像/google-chrome-stable_current_amd64.deb .` |
|
||||
| 镜像内容 | 构建阶段已跑 `npm ci` + `npm run build`,产物 `/app/yun-xue-tang-assistant.user.js` 在镜像里;`node_modules` / `.run-profile` / `run-logs` / `.env` 由 `.dockerignore` 排除在外 |
|
||||
|
||||
Linux 上不需要 Xvfb,但如果你确实想跑有界面模式(例如远程看面板、人工过验证码),
|
||||
可以 `apt install xvfb x11vnc` 后 `xvfb-run -s "-screen 0 1360x940x24" npm run headless -- --headless 0`。
|
||||
|
||||
@@ -323,6 +381,11 @@ Windows 下也可以直接双击 [`scripts/start-dev.cmd`](scripts/start-dev.cmd
|
||||
README.md 说明文档(本文件)
|
||||
package.json / package-lock.json npm scripts 与依赖锁(唯一依赖:esbuild)
|
||||
.gitattributes / .gitignore 换行符与忽略规则
|
||||
Dockerfile 容器镜像:Node 22 + 官方 Chrome,构建期完成 npm run build
|
||||
docker-compose.yml 一键构建 / 自检 / 常驻(挂载 profile、日志,限制 shm 与日志大小)
|
||||
.dockerignore 镜像上下文排除 node_modules / .run-profile / run-logs / docs
|
||||
docker/
|
||||
entrypoint.sh 容器入口:建目录 → 无凭据时降级 --check → exec 运行器
|
||||
yun-xue-tang-assistant.user.js 构建产物(唯一需要安装的文件,不要手改)
|
||||
src/ 业务脚本源码(拆成多个模块,日常改这里)
|
||||
meta.js UserScript 头 + 用法注释
|
||||
@@ -361,6 +424,7 @@ runner/ 无头运行器(Linux / Windows,无图形
|
||||
supervisor.mjs 崩溃重启循环与退出码
|
||||
config/
|
||||
runner.config.mjs 无头运行器配置(日常调参改这里,不用 build)
|
||||
.env.example 账号环境变量模板(复制成 .env 后填;.env 不入库)
|
||||
dev/ 本地热加载开发工具(HTTP 服务 + 薄加载器)
|
||||
serve.mjs 本地 HTTP 服务(默认 127.0.0.1:8899)
|
||||
dev-loader.user.js Tampermonkey 里的薄加载器
|
||||
|
||||
Reference in new issue
Block a user