README.md

npipe

客户端

Windows上将客户端注册为服务（必须在有管理员权限的控制台中执行）

Usage: np_client.exe install [OPTIONS] --server <SERVER> --username <USERNAME> --password <PASSWORD>

Options:
      --backtrace <BACKTRACE>
          print backtracking information [default: false] [possible values: true, false]
  -s, --server <SERVER>
          server address
  -u, --username <USERNAME>
          username
  -p, --password <PASSWORD>
          password
      --enable-tls
          enable tls
      --insecure
          if true, the validity of the SSL certificate is not verified
      --ca-cert <CA_CERT>
          ca file path (optional), if not provided, the client’s certificate will not be verified [default: ]
      --log-level <LOG_LEVEL>
          set log level [default: info]
      --base-log-level <BASE_LOG_LEVEL>
          set log level [default: error]
      --net-type <NET_TYPE>
          net type [default: tcp] [possible values: tcp, kcp, auto]
  -h, --help
          Print help (see more with '--help')

Windows上卸载服务

Usage: np_client.exe uninstall

Windows上和其他平台以常规模式运行

Usage: np_client.exe run [OPTIONS] --server <SERVER> --username <USERNAME> --password <PASSWORD>

Options:
      --backtrace <BACKTRACE>
          print backtracking information [default: false] [possible values: true, false]
  -s, --server <SERVER>
          server address
  -u, --username <USERNAME>
          username
  -p, --password <PASSWORD>
          password
      --enable-tls
          enable tls
      --insecure
          if true, the validity of the SSL certificate is not verified
      --ca-cert <CA_CERT>
          ca file path (optional), if not provided, the client’s certificate will not be verified [default: ]
      --log-level <LOG_LEVEL>
          set log level [default: info]
      --base-log-level <BASE_LOG_LEVEL>
          set log level [default: error]
      --net-type <NET_TYPE>
          net type [default: tcp] [possible values: tcp, kcp, auto]
  -h, --help
          Print help (see more with '--help')
Usage: np_client.exe run [OPTIONS] --server <SERVER> --username <USERNAME> --password <PASSWORD>

Options:
      --backtrace <BACKTRACE>
          print backtracking information [default: false] [possible values: true, false]
  -s, --server <SERVER>
          server address
  -u, --username <USERNAME>
          username
  -p, --password <PASSWORD>
          password
      --enable-tls
          enable tls
      --insecure
          If true, the validity of the SSL certificate is not verified
      --ca-cert <CA_CERT>
          ca file path (optional), if not provided, the client’s certificate will not be verified [default: ]
      --log-level <LOG_LEVEL>
          set log level [default: info]
      --base-log-level <BASE_LOG_LEVEL>
          set log level [default: error]
  -h, --help
          Print help

---

服务端

服务端配置文件

名称	含义	示例
database_url	数据库地址	sqlite格式 sqlite://data.db?mode=rwc mysql格式 mysql://username:password@server:port/dbname, 如:mysql://admin:password@127.0.0.1:3306/npipe
listen_addr	服务端tcp监听地址	0.0.0.0:8118
kcp_listen_addr	服务端kcp监听地址	0.0.0.0:8118
enable_tls	启用tls连接	true/false
tls_cert	cert文件路径	./cert.pem
tls_key	key文件路径	./server.key.pem
web_base_dir	web后台管理路径 (为空则关闭web管理)	./dist
web_addr	web管理监听地址	0.0.0.0:8120
web_username	web界面管理账号 (为空则关闭web管理)	admin
web_password	web界面管理密码 (为空则关闭web管理)	admin@1234
illegal_traffic_forward	非法流量请求转发地址	可以将不是npipe的流量转发给其他程序，如nginx，配置格式示例：127.0.0.1:80 ，如果为空则不转发请求

使用方法

1. 启动服务器 ./np_server

2. 访问web管理后台 127.0.0.1:8120，添加用户和隧道

---

隧道配置

名称	含义
source	隧道入口监听地址
endpoint	隧道出口地址,SOCKS5类型此字段无效，随便写一个合法格式即可
enabled	是否启用
compressed	是否压缩（使用lz4压缩）
sender	隧道出口用户id(发送请求那一方)，为0则表示是出口在服务端
receiver	隧道入口用户id（接收监听那一方）,为0则表示入口在服务端
description	描述字段
tunnel_type	隧道类型 TCP UDP SOCKS5
username	SOCKS5代理认证用户名
password	SOCKS5代理认证密码
encryption_method	隧道加密方式(启用tls连接之后就不需要加密了)
custom_mapping	自定义域名(功能未实现)

如：
   source配置 0.0.0.0:3000
   endpoint配置 www.baidu.com:80
   sender配置 1234（如1234是用户xxx的id）
   receiver配置 0
   
启动 np_client登录用户xxx
在np_client所在的电脑上访问 127.0.0.1:3000 即代表从服务端访问 www.baidu.com:80

---

感谢 pizixi 开发的后台管理界面