准备
- 安装 Node.js 24 或更新版本,安装包里自带 npm。
- 安装 Git。Windows 请装 Git for Windows,之后的命令都在它附带的 Git Bash 里执行。
- 准备一个模型账号或 API Key,能在 DSH 的模型设置里配置就行。先配好老师用的模型,后台工作员的模型以后再说。
打开终端,确认这三条命令都有输出:
node --version
npm --version
git --version
第一条应该显示 v24 或更新。刚安装或切换过 Node 的话,先重新打开终端。
安装并启动
git clone https://github.com/TongZi2003/Notara.git Notara-Vault
cd Notara-Vault
npm ci --no-audit --no-fund
npm run vault
依赖装好后,启动器会构建插件、创建学习数据目录,再打开浏览器。第一次启动和第一次打开 PDF 时可能要多等一会儿。
第一次打开
- 配置模型。首次引导里就可以配,也可以稍后在左下角“设置 → 模型”里添加。按服务商的要求填写,API Key 只填在设置里,不要发进课堂对话。
- 选学习目录。左侧是“首页、计划、Vault、技能”四个图标。在首页面板里选一个学习目录,启动器已经准备了一个默认的,也可以选你自己的资料目录。
- 写下第一道题。在输入框里写题目和你自己的尝试,发送。老师回复后可以接着讨论,也可以切到白板。
- 想换教法,打开空白课堂的“课程选项”,课上也能在教学设置里调整。
第一节课具体怎么上,见第一节课。
模型连不上时,先在模型设置里核对服务商、地址、模型名和凭据。连接失败不会清空你的文件和课堂。
日常打开和停止
cd Notara-Vault
npm run vault
服务运行时保持终端开着,按 Ctrl+C 停止。下次执行同一条命令,已有的资料和课堂都还在。
服务还开着,但浏览器关了或者换了浏览器,执行:
npm run vault:open
登录链接里带着临时认证信息,不要分享给别人。直接打开不带认证的地址可能会看到 401,用上面这条命令重新打开就好。
数据放在哪
学习数据默认在用户目录下的 .notara/vault-runtime,服务端口默认 57093。数据目录和你克隆下来的代码目录是分开的,里面有课堂、资料、模型配置和认证材料。
想用别的目录或端口:
npm run vault -- --root /你的数据目录 --port 47093
npm run vault:open -- --root /你的数据目录
Windows 的 Git Bash 里可以写成 C:/Users/你的用户名/NotaraData,路径里有空格就加双引号。
升级和回退
升级前一定先备份
从 0.21.0 以前的版本升级,第一次打开旧课堂时会把会话迁到新格式,旧版读不了。
- 在运行服务的终端按
Ctrl+C,确认服务已经停了。 - 把整个
.notara/vault-runtime复制到别处备份,隐藏文件也要带上,不要只备份workspace。备份里有凭据,留在自己的电脑上。 - 在代码目录执行:
git pull --ff-only
npm ci --no-audit --no-fund
npm run vault:upgrade
npm run vault
用了自定义数据目录的,后两条要加上同样的 -- --root /你的数据目录。
升级器会保留课堂、资料和模型配置,旧的插件快照和已经装好的像素教室也会留着;中途失败会撤回这次的安装改动。当前版本号在“设置 → 学习界面”底部能看到。
需要回退时,先停掉新版,换回旧代码和它的依赖,再把整份备份恢复到原来的数据目录位置。只换回插件快照,退不回已经迁移过的课堂。
Windows
- 所有命令在 Git Bash 里执行。老师执行命令时用的也是 Git Bash。
- Git Bash 装在特殊位置时,用环境变量
NOTARA_GIT_BASH指向bash.exe。 - Windows 版还没有完成实机验收,遇到问题欢迎到 GitHub 反馈。
遇到问题
| 现象 | 怎么办 |
|---|---|
提示需要 Node 24,可 node --version 明明是 24 | 电脑上可能有好几套 Node,npm 找到了另一套。装完依赖后用 npm exec --offline -- node --version 核对,让 Node 24 的目录排在 PATH 前面。 |
| 页面显示 401,或浏览器没打开 | 服务开着时执行 npm run vault:open;自定义目录要带上同样的 --root。 |
| 端口被占用 | 先看看是不是已经开着一个。新开实例可以指定别的空闲端口,不要删学习目录。 |
| 提示必须升级插件 | 停掉服务,完整备份,再执行 npm run vault:upgrade。只拉取代码不会替换插件。 |
| Windows 找不到 Bash | 装好 Git for Windows 后重新打开 Git Bash;装在特殊位置的,用 NOTARA_GIT_BASH 指定 bash.exe。 |
| 模型一直不回复 | 核对模型配置、余额和网络。需要排查时,在“设置 → 学习界面”打开“显示调试记录”。把报错发给别人前,去掉凭据和私密的课堂内容。 |
更完整的说明在 GitHub 仓库的安装文档里。