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

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

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

    • 客户端使用
    • 客户端增强功能
    • NPC SDK
    • 客户端配置与启动
    • 配置文件参考
    • NPC GUI 客户端
  • 扩展功能

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

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

客户端使用

直接运行

直接双击 npc/npc.exe,无任何参数,按提示输入即可:

菜单项输入内容
注册系统服务【快捷启动命令】或【TLS 快捷启动命令】
卸载系统服务隧道密钥 vkey
启动隧道密钥 vkey
停止隧道密钥 vkey
更新客户端—

【快捷启动命令】在 web 后台 → 客户端列表 → 客户端前的小图标里复制,本质是 服务端地址 + vkey 的 base64 编码。TLS 模式有独立的【TLS 快捷启动命令】。

服务以 nps-client-<vkey> 命名注册,可在同一台机器并存多个客户端实例。

image

直接命令行

./npc -server=ip:port -vkey=web界面中显示的密钥         # 标准
./npc -server=ip:8025 -vkey=xxx -tls_enable=true       # TLS 桥接
./npc -server=ip:8024 -vkey=ytkpyr0er676m0r7,iwnbjfbvygvzyzzt  # 同时拉起多个隧道 ID(逗号拼接)

配置文件模式

无配置文件模式适合由 Web 管理面板统一维护客户端、隧道和域名规则;配置文件模式则适合批量部署、将规则纳入基础设施代码,或使用健康检查、端口范围映射等进阶能力。

./npc -config=conf/npc.conf

一个配置文件使用 [common] 定义 server_addr、vkey、TLS 和日志等公共参数,再用多个规则节定义 TCP、UDP、Host、Secret、P2P 或文件访问。完整字段、模板环境变量和可运行示例见 NPC 配置文件参考。

GUI 客户端

基于 Wails 开发的桌面 GUI,体积只有 5M,免安装,解压即用。

支持两种添加客户端方式:

  1. 粘贴 web 后台的【快捷启动命令】
  2. 手动填写 -server、-vkey 等参数

详细说明请参考 GUI 客户端 README。

img

注册到系统服务

实现开机启动、守护进程

./npc          # linux/darwin(需 sudo)
npc.exe        # windows(管理员 cmd)

按菜单选「注册系统服务」并粘贴【快捷启动命令】或【TLS 快捷启动命令】即可,服务名为 nps-client-<vkey>。

Windows 如果需要当客户端退出时自动重启客户端,请按照如图所示配置

img

系统服务日志

注册系统服务后日志按 每个 vkey 一个文件 保存,命名为 npc-<vkey>.log:

  • windows:与 npc.exe 同级目录
  • linux / darwin:/var/log/

客户端更新

运行客户端,会显示当前客户端版本号。

./npc          # 选择菜单 [5] 更新客户端

自动下载并替换 npc 二进制。

如果无法成功更新,可以直接下载 releases 压缩包覆盖原有的 npc 二进制。

在 GitHub 上编辑此页
最后更新: 2026/9/1 19:28
Next
客户端增强功能