运行命令速查
本页只放运行和管理命令。首次部署、目录说明和注意事项请先看 安装部署。
NPS 服务端
查看版本
./nps -version
直接运行
Linux/macOS:
./nps
Windows:
nps.exe
直接运行时,配置目录是程序所在目录下的 conf。新安装的 Web 面板默认仅监听本机:
http://127.0.0.1:8081
指定配置目录
./nps -conf_path=/data/nps
程序会读取:
/data/nps/conf/nps.conf
系统服务
安装命令仍然可以使用。install、start、stop、restart、uninstall 是非交互命令,适合脚本、CI 或运维手册直接执行。
Linux/macOS:
sudo ./nps install
sudo nps start
sudo nps stop
sudo nps restart
sudo nps uninstall
Windows 需要管理员 CMD 或 PowerShell:
nps.exe install
nps.exe start
nps.exe stop
nps.exe restart
nps.exe uninstall
交互菜单
./nps -server 不是安装命令本身,而是打开服务端交互管理菜单。菜单内部仍然可以执行安装、卸载、更新、启动、停止等操作。
./nps -server
菜单项:
| 输入 | 操作 |
|---|---|
1 | 安装 NPS,并立即尝试启动服务 |
2 | 停止并删除/卸载 NPS 服务 |
3 | 更新 NPS |
4 | 查看 NPS 服务状态 |
5 | 启动 NPS 服务 |
6 | 停止 NPS 服务 |
7 | 重启 NPS 服务 |
0 | 退出菜单 |
如果只是安装服务,./nps install 仍然是最直接的方式。交互菜单更适合不想记命令时手动管理服务。
注意:命令行安装和交互菜单安装的配置目录行为不同。直接执行 ./nps install 会安装到系统默认目录,Linux 默认使用 /etc/nps/conf。交互菜单的 1 会以当前程序目录作为配置目录,并把 -conf_path=<当前程序目录> 写入服务参数。
NPC 命令行客户端
查看版本
./npc -version
无配置文件模式
./npc -server=<服务器IP>:8024 -vkey=<VerifyKey>
TLS:
./npc -server=<服务器IP>:8025 -vkey=<VerifyKey> -tls_enable=true
多个客户端:
./npc -server=<服务器IP>:8024 -vkey=key1,key2,key3
通过代理连接服务端:
./npc -server=<服务器IP>:8024 -vkey=<VerifyKey> \
-proxy=socks5://user:pass@127.0.0.1:9007
配置文件模式
./npc -config=npc.conf
未指定 -config 时,源码默认查找:
- Windows:程序目录下的
conf/npc.conf - Linux/macOS:当前工作目录下的
conf/npc.conf
交互式菜单
./npc
如果没有传入 -server、-vkey,并且没有找到本地配置文件,npc 会进入交互菜单。菜单也支持直接粘贴 Web 面板生成的快捷启动命令。
菜单项:
| 输入 | 操作 |
|---|---|
1 | 注册系统服务,需要输入快捷启动命令;可一次输入多个,用英文逗号分隔 |
2 | 删除/卸载系统服务,需要输入 vkey;会先停止服务再卸载,可一次输入多个,用英文逗号分隔 |
3 | 启动系统服务,需要输入 vkey |
4 | 停止系统服务,需要输入 vkey |
5 | 更新客户端 |
6 | 查看已注册的 nps-client-* 服务列表,并显示每个服务状态 |
7 | 查看指定 vkey 对应服务的状态 |
0 | 退出菜单 |
| 快捷启动命令 | 不安装服务,直接启动连接;可一次输入多个,用英文逗号分隔 |
系统服务
命令行安装也仍然可以使用,适合明确知道 server 和 vkey 的场景:
sudo ./npc install -server=<服务器IP>:8024 -vkey=<VerifyKey>
sudo npc start
命令行安装会注册通用 Npc 服务,安装参数会作为服务启动参数保存。交互菜单的 1 更适合从 Web 面板复制快捷启动命令注册服务。它会按 vkey 创建独立服务,服务名格式为 nps-client-<vkey>,多个客户端更好管理。菜单里的 2 会删除/卸载对应独立服务,6 可以查看当前机器上已经注册的独立服务列表。
Linux 上请使用 sudo 执行安装。服务注册后会使用 /usr/bin/npc 或 /usr/local/bin/npc 的稳定路径,不依赖当前解压目录。
NAT 类型检测
./npc nat -stun_addr=stun.stunprotocol.org:3478
P2P/Secret 本地访问端
Secret:
./npc -server=<服务器IP>:8024 -vkey=<VerifyKey> \
-password=<Secret密码> -local_type=secret -local_port=2000
P2P:
./npc -server=<服务器IP>:8024 -vkey=<VerifyKey> \
-password=<P2P密码> -target=<目标IP:端口> -local_type=p2p -local_port=2000
NPC GUI 客户端
GUI 没有 npc 的命令行参数。启动桌面程序后添加连接:
- 在 NPS Web 面板进入「客户端」。
- 展开客户端详情,复制「快捷启动命令」或「TLS 快捷启动命令」。
- 打开 NPC GUI,粘贴快捷启动命令并添加。
- 点击连接。
也可以手动填写:
- 名称
- 服务端地址,例如
<服务器IP>:8024 VerifyKey- 是否启用 TLS
GUI 的配置和日志位置见 GUI 客户端。
Docker
NPS 服务端:
docker run -d --name nps \
-p 80:80 -p 443:443 \
-p 8024:8024 -p 8025:8025 \
-p 8081:8081 \
-v /opt/nps/conf:/conf \
wushuo98/nps
NPC 客户端:
docker run -d --name npc wushuo98/npc \
-server=<服务器IP>:8024 -vkey=<VerifyKey>
更多 Docker 说明见 Docker 部署。
