使用说明页面配置
登录后可从「系统 → 使用说明」打开帮助页。页面内容由管理员在 「系统 → 全局参数」的「全局参数」Tab 中统一维护,管理员和普通用户看到的是同一份内容。 配置保存在 conf/global.json,不会写入或修改 nps.conf,保存后立即生效, 不需要重启 NPS。
说明窗口会铺满顶部导航和侧边栏之外的可用内容区,随窗口尺寸自动调整宽高; 正文在嵌入窗口内滚动。来源信息与刷新、新窗口打开等操作合并在紧凑工具栏中, 小屏幕自动换行,不再限制为固定宽度或最小 560px 高度。
支持的三种内容来源
「系统 → 全局参数」的「全局参数」Tab 使用一个输入框,根据内容自动判断 来源,不需要管理员先选择模式。
| 输入示例 | 识别结果 | 存储与展示 |
|---|---|---|
https://docs.example.com/nps/ | 远程 URL | URL 保存在 global.json,帮助页通过 iframe 加载 |
conf/QA.html、/conf/QA.html、QA.html | 本地 HTML | 路径归一化为 conf/QA.html,从当前运行目录的 conf 下读取 |
以 < 开头的 HTML | 内嵌 HTML | 保存时原子写入 conf/qa.html,帮助页从该文件读取 |
| 留空 | 关闭 | 帮助页显示“管理员尚未配置使用说明” |
远程 URL
远程地址只支持 http:// 和 https://,NPS 不会在服务端抓取或缓存网页。 浏览器是否允许嵌入取决于目标站点的 X-Frame-Options、Content-Security-Policy 和登录状态。目标站点拒绝 iframe 时,帮助页仍可打开,用户可以通过页面右上角的 「新窗口打开」访问。
如果 NPS 管理面板本身使用 HTTPS,而说明 URL 使用 HTTP,现代浏览器通常会按 混合内容策略拦截。此时页面会显示提示,应把说明站点切换到 HTTPS。
conf 下的本地 HTML
本地文件只允许 .html 和 .htm,并且必须位于当前 NPS 运行目录的 conf 目录内。路径穿越、符号链接指向 conf 外部、访问 nps.conf 等非 HTML 文件 都会被拒绝。
文件可以先用部署工具放到 conf 下,再在「系统 → 全局参数」的「全局参数」 Tab 中填写路径。即使文件尚未部署,帮助页也不会报 404,而是显示“使用说明文件不存在”; 文件放好后刷新页面即可看到,无需重启 NPS。
直接粘贴 HTML
在输入框中直接粘贴以 < 开头的 HTML 时,保存操作会把内容写入或覆盖 conf/qa.html,单份内容最大为 8 MB。写入采用临时文件加原子替换;如果随后 global.json 保存失败,服务端会回滚到保存前的内容。
管理员也可以在部署流程中直接替换 conf/qa.html,刷新帮助页即可更新内容。 再次在面板中粘贴 HTML,会继续覆盖这个文件。
安全边界
- 帮助页只允许已登录用户访问,不会向未登录访客公开
conf内容。 - 本地 HTML 通过独立响应提供,并设置
Content-Security-Policy: sandbox。 文档中的脚本和表单可以运行,但页面处于不透明源,不能读取管理面板 Cookie、 会话或父页面 DOM。 - 远程 URL 属于第三方页面,NPS 无法控制其隐私、可用性和脚本行为。应使用可信 文档站,并建议保持 HTTPS。
- 帮助页不会把本地文件路径映射为静态目录;请求只能读取当前配置指定的那一份 HTML。
常用操作
- 以管理员登录,进入「系统 → 全局参数」的「全局参数」Tab。
- 在「使用说明」卡片输入 URL、
conf下的 HTML 路径,或直接粘贴 HTML。 - 输入框下方会实时提示识别为“远程页面”“本地文件”或“粘贴 HTML”。
- 保存后点击底部提示中的「打开使用说明」检查实际效果。
- 需要关闭帮助内容时清空输入框并保存。
普通用户没有全局配置权限,但可以从「IP 登记」管理自己客户端下的访问 IP: 普通用户只能查看、撤销、清理和清空自己的登记,管理员还能管理所有用户和 公共登记桶。详细权限边界见用户体系。
