NPSNPS
首页
  • 安装与部署
  • 快速开始
  • 运行命令速查
  • 隧道模式
  • 使用示例
  • 使用说明
  • 配置文件
  • 增强功能
  • Docker 部署
  • 参数与安全速查
  • 使用说明
  • 增强功能
  • 配置与启动
  • 配置文件参考
  • 更新与远程升级
  • SDK
  • 功能概览
  • 域名代理与路由
  • 平台域名与证书诊断
  • 访问控制与配额
  • 运行说明
  • 配置示例
  • 对外 API v1
  • API 鉴权与兼容
  • 历史 Web API
  • 用户体系
  • FAQ
  • 升级迁移
  • 功能与兼容矩阵
  • 本项目更新日志
  • 上游更新日志
GitHub
首页
  • 安装与部署
  • 快速开始
  • 运行命令速查
  • 隧道模式
  • 使用示例
  • 使用说明
  • 配置文件
  • 增强功能
  • Docker 部署
  • 参数与安全速查
  • 使用说明
  • 增强功能
  • 配置与启动
  • 配置文件参考
  • 更新与远程升级
  • SDK
  • 功能概览
  • 域名代理与路由
  • 平台域名与证书诊断
  • 访问控制与配额
  • 运行说明
  • 配置示例
  • 对外 API v1
  • API 鉴权与兼容
  • 历史 Web API
  • 用户体系
  • FAQ
  • 升级迁移
  • 功能与兼容矩阵
  • 本项目更新日志
  • 上游更新日志
GitHub
  • 文档首页
  • 快速上手

    • 安装与部署
    • 快速开始
    • 运行命令速查
    • 完整部署参考
    • 隧道模式
    • 使用示例
  • 服务端

    • 服务端使用
    • 使用说明页面配置
    • 配置文件参考
    • 服务端增强功能
    • 服务端介绍
    • 部署安全与参数速查
    • Docker 部署
    • 宝塔面板部署
  • 客户端

    • 客户端使用
    • 客户端增强功能
    • NPC SDK
    • 客户端配置与启动
    • 配置文件参考
    • NPC Docker 部署
    • 飞牛 fnOS 原生包
    • NPC GUI 客户端
    • 客户端更新与远程升级
  • 扩展功能

    • 功能概览
    • 域名代理与路由
    • 平台域名与证书诊断
    • 访问控制与配额
    • 运行说明
    • 对外 API v1
    • API 鉴权与兼容
    • 历史 Web API
    • 使用示例
  • 项目与社区

    • 用户体系
    • 系统架构
    • 升级迁移
    • 功能与兼容矩阵
    • 构建发布
    • 本项目更新日志
    • 上游更新日志
    • FAQ
    • 贡献
    • 交流
    • 捐助
    • 致谢

服务端使用

首次启动

新安装默认访问 http://127.0.0.1:8081。管理员用户名为 admin, web_password、auth_key 和 auth_crypt_key 会在首次启动时随机生成并 打印到终端。发布模板中的 CHANGE_ME 和历史弱占位值也会自动轮换。

远程管理应通过 HTTPS 反向代理,或把 web_ip 限制为受控管理网段并开启 web_open_ssl。完整安全边界见部署安全与参数速查。

Web 管理入口

当前导航按资源类型分组:

  • 客户端、用户管理、域名反代和各类隧道。
  • 「系统 → 全局参数」:业务参数、用户注册、nps.conf、证书设置和登录安全。
  • 「系统 → 登录封禁」:查看和管理登录失败封禁状态。
  • 「系统 → 审计与连接」:操作审计与客户端连接日志。
  • 「系统 → IP 登记」:管理员查看全部登记;普通用户只查看自己客户端下的登记。
  • 「系统 → 账户管理」:管理员密钥、普通用户 Token、TOTP、登录设备和免登凭证。
  • 「系统 → 使用说明」:显示管理员配置的帮助内容。

「全局参数」页面包含五个 Tab:

  1. 全局参数
  2. 用户注册
  3. 服务端配置
  4. 证书设置
  5. 安全

完整字段见服务端配置文件参考,增强功能见 服务端增强功能。

手机访问登录、注册与 IP 登记

这三个入口复用桌面端地址和认证流程,无需另外启用移动版。手机上会把介绍区 压缩为品牌条,以单列显示表单;内容较长或横屏时整页纵向滚动,页脚跟随内容, 不会挤占表单宽度。明暗主题、网络背景动画和中英文切换保持可用。

图片验证码与输入框并排显示,邮箱验证码按钮保留在输入框旁;按配置启用的 邮箱验证、TOTP、PoW 和“3 天内免登录”不会因手机布局而省略。IP 登记页的 完整 IPv6 地址及识别来源会自动换行,登记口令、有效期和代理警告保持显示。

配置重载与重启

Linux/macOS 上可重新加载认证和管理面板配置:

sudo nps reload

reload 适用于 web_username、web_password、auth_key、 auth_crypt_key 等可在线读取的认证配置。Windows,以及监听端口、Bridge、 代理、证书、日志和隧道相关配置变更,应执行:

sudo nps restart

Windows:

nps.exe restart

变更前建议先备份 conf 目录。

系统服务

./nps install
nps start
nps stop
nps restart
nps uninstall

Windows 使用管理员 CMD 或 PowerShell 执行 nps.exe install/start/stop/restart。 交互菜单:

./nps -server

菜单覆盖安装、卸载、启停、重启和更新。系统服务与交互菜单的具体命令见 运行命令速查。

工作目录与数据

服务端直接运行时使用程序目录下的 conf;Linux 系统服务默认使用 /etc/nps/conf。Docker 通常挂载到 /conf。

conf/
├── nps.conf
├── clients.json
├── tasks.json
├── hosts.json
├── users.json
├── global.json
└── web_sessions.json

证书和 Geo 数据还会在 conf 下创建或引用相应文件,日志位置以配置为准。不要只备份 nps.conf 而遗漏 JSON 数据和证书。web_sessions.json 保存 3 天免登设备的 服务端登记,删除后所有免登 Cookie 会失效,但正常账号密码登录不受影响。

审计与连接日志

在“系统 → 审计与连接”查看“管理操作与登录”和“客户端与代理连接”。 动作显示为“登录”等可读名称,悬浮及展开的 JSON 保留 auth.login 等原始代码。 搜索可用中文动作、账号、来源 IP、请求 ID 或浏览器,更多请求/认证字段可从“列”开启。 记录区占满可用内容,桌面表头固定,手机以卡片展示;展开后可复制完整事件。

为避免大日志拖慢页面,两个 Tab 都只从对应日志文件的尾部读取最近最多 2000 条, 按新到旧展示,仍按每页 50 条分页。搜索、动作/协议筛选和数量统计只针对这个最近窗口, 普通用户在此窗口内仅能看到已归属自己的记录;不会为了凑满用户记录而继续扫描整个文件。 超过窗口的旧记录仍保留在文件中,不会因加载限制被删除;/api/v1/audit 和 /api/v1/audit/connections 保持原有历史查询行为。

管理员可在右上角点击“清理旧日志”,手动填写保留天数(默认 30 天,允许 1~36500 天), 核对当前日志类型及截止时间,勾选确认后执行。例如保留 7 天会删除执行时刻之前超过 7×24 小时的记录,截止时刻相等的记录仍保留。清理只影响当前 Tab 对应的活动 JSONL 文件, 不处理外部轮转归档、nps.log、用量历史或客户端数据;普通用户没有清理权限。

清理会扫描历史文件,使用同目录临时文件替换并保留 NPS 在扫描期间追加的记录; 目录需要可写权限和足够的临时空间。无法识别时间、格式损坏、超大或未完整写入的记录 会保守保留。界面会显示清理条数和释放的文件字节数,清理本身写入 audit.cleanup 审计。 删除不可撤销,操作前请先备份;若请求等待超时,请稍后刷新确认结果,不要立即重复提交。

audit_log_path 非空才会记录登录成功、登录各阶段失败、免登签发/恢复、退出及管理操作; connection_log_path 独立记录 Bridge 与代理会话。路径留空关闭对应日志。 用户只能看自己的已归属记录,匿名失败只向管理员开放。日志不保存凭据或正文。 Docker 持久化、文件权限和归档见 1.1.44 升级说明; 本版飞牛纯连接重连与日志顺序修复见 1.1.47 升级说明。

更新与迁移

./nps -server

选择“更新”或按构建发布中的正式 Release 流程操作。更新程序 默认只替换二进制,不删除配置和业务数据。

迁移到新服务器时停止 NPS,完整复制 conf 目录,再使用相同运行权限启动。 现有 nps.conf 会自动补齐新版必需字段并保留已有值、注释和自定义项;升级前 仍应先备份并检查启动日志。

调试

启动失败时先停止系统服务,再直接运行 ./nps 查看控制台日志:

sudo nps stop
./nps

注意确认当前工作目录,因为直接运行与系统服务使用的配置目录可能不同。

在 GitHub 上编辑此页
最后更新: 2026/11/16 23:39
Next
使用说明页面配置