\n
![](\"https://cdn.rawgit.com/oyyd/nysocks/fa173e5c/imgs/tcp.png\")
\n\n**nysocks fast2 mode:**\n\n
![](\"https://cdn.rawgit.com/oyyd/nysocks/fa173e5c/imgs/fast2.png\")
\n\n## How it works\n\n**for SOCKS client**\n\n\n\n**for SS client**\n\n\n\n**protocol(unstable):**\n\n```\n+-------+-----+-----+---------+---------+--------+------------+\n| kcp | ver | cmd | nonce | mux.cmd | mux.id | mux.length |\n+-------+-----+-----+---------+---------+--------+------------+\n| 24 | 1 | 1 | 8 | 1 | 2 | 4 |\n+-------+-----+-----+---------+---------+--------+------------+\n```\n\n## About the Tunnel Implementation\n\nThe tunnel connections in nysocks is implemented as a [node-addon(C/CPP)](https://nodejs.org/api/addons.html) mainly because:\n\n0. Node don't support setting send/recv buffer size of udp connections before v8.7.0.\n0. In large data transmissions, udp message callback is too frequently and manipulating buffers in js(or any other script languages) is relatively expensive which would make the total performace unacceptable. You can check my pure js implementation [here](https://github.com/oyyd/kcp-node/).\n\nStill, I'm not a professional C/CPP language user or network programmer. Please submit PRs or issues to help us improve it!\n\n## Installation\n\n`node >= 6.x`\n\n**Make sure** you have [node-gyp](https://github.com/nodejs/node-gyp#installation) installed successfully as nysocks will build C/CPP code, then:\n\n```\nnpm i nysocks -g\n```\n\n## Usage\n\n#### 1. Create server service\n\nIn your server, start nysocks with `server` command:\n\n```\nnysocks server -p 20000 -k YOUR_PASSWORD -m fast\n```\n\n#### 2. Create client service\n\nIn your client, start nysocks with `client` command to create a tunnel client that will connect to your server and provide proxy service:\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast\n```\n\nNysocks will start a SOCKS5 service to tunnel your tcp connections. Now you can [utilize the SOCKS5 service](https://github.com/oyyd/nysocks#how-to-utilize-the-socks5-service) (default port `1080`). A [PAC](https://en.wikipedia.org/wiki/Proxy_auto-config) file server will also be served(default port `8090`) for convenience.\n\n**Use SS Protocol**\n\nNysocks supports using shadowsocks protocol to replace SOCKS5 protocol in your client:\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast --client_protocol SS --ss_password YOUR_SS_PASSWORD --ss_method aes-128-cfb\n```\n\nCheck [the ssServer from encryptsocks](https://github.com/oyyd/encryptsocks) for more details.\n\n#### 3. Use `config.json`\n\nYou can create a `config.json` file like [this](#config) that containing your configs to avoid verbose cli options:\n\n```\nnysocks client -c config.json\n```\n\n#### 4. Use daemons\n\nAdd `-d` options if you want to run under daemons([pm2](http://pm2.keymetrics.io/)):\n\n```\nnysocks client -d restart -c config.json\n```\n\n#### 5. Check other options\n\nModify your options in the CLI. See other options here:\n\n```\nnysocks -h\n```\n\n## Configs\n\nCLI:\n\n```\nnysocks \n
\n\n**nysocks fast2 mode:**\n\n
\n\n## How it works\n\n**for SOCKS client**\n\n\n\n**for SS client**\n\n\n\n**protocol(unstable):**\n\n**NOTE:** The protocol of nysocks has been changed from v1.3.0 so that you have to install nysocks v1.3.x in both of your client and server.\n\n\n```\n+-------+-----+-----+---------+---------+--------+------------+\n| kcp | ver | cmd | nonce | mux.cmd | mux.id | mux.length |\n+-------+-----+-----+---------+---------+--------+------------+\n| 24 | 1 | 1 | 8 | 1 | 2 | 4 |\n+-------+-----+-----+---------+---------+--------+------------+\n```\n\n## About the Tunnel Implementation\n\nThe tunnel connections in nysocks is implemented as a [node-addon(C/CPP)](https://nodejs.org/api/addons.html) mainly because:\n\n0. Node don't support setting send/recv buffer size of udp connections before v8.7.0.\n0. In large data transmissions, udp message callback is too frequently and manipulating buffers in js(or any other script languages) is relatively expensive which would make the total performace unacceptable. You can check my pure js implementation [here](https://github.com/oyyd/kcp-node/).\n\nStill, I'm not a professional C/CPP language user or network programmer. Please submit PRs or issues to help us improve it!\n\n## Installation\n\n`node >= 6.x`\n\n**Make sure** you have [node-gyp](https://github.com/nodejs/node-gyp#installation) installed successfully as nysocks will build C/CPP code, then:\n\n```\nnpm i nysocks -g\n```\n\nOr check the executable [here](https://github.com/oyyd/nysocks/releases).\n\n## Usage\n\n#### 1. Create server service\n\nIn your server, start nysocks with `server` command:\n\n```\nnysocks server -p 20000 -k YOUR_PASSWORD -m fast\n```\n\n#### 2. Create client service\n\nIn your client, start nysocks with `client` command to create a tunnel client that will connect to your server and provide proxy service:\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast\n```\n\nNysocks will start a SOCKS5 service to tunnel your tcp connections. Now you can [utilize the SOCKS5 service](https://github.com/oyyd/nysocks#how-to-utilize-the-socks5-service) (default port `1080`). A [PAC](https://en.wikipedia.org/wiki/Proxy_auto-config) file server will also be served(default port `8090`) for convenience.\n\n**Use SS Protocol**\n\nNysocks supports using shadowsocks protocol to replace SOCKS5 protocol in your client:\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast --client_protocol SS --ss_password YOUR_SS_PASSWORD --ss_method aes-128-cfb\n```\n\nCheck [the ssServer from encryptsocks](https://github.com/oyyd/encryptsocks) for more details.\n\n#### 3. Use `config.json`\n\nYou can create a `config.json` file like [this](#config) that containing your configs to avoid verbose cli options:\n\n```\nnysocks client -c config.json\n```\n\n#### 4. Use daemons\n\nAdd `-d` options if you want to run under daemons([pm2](http://pm2.keymetrics.io/)):\n\n```\nnysocks client -d restart -c config.json\n```\n\n#### 5. Check other options\n\nModify your options in the CLI. See other options here:\n\n```\nnysocks -h\n```\n\n## Configs\n\nCLI:\n\n```\nnysocks \n
\n\n**nysocks“fast2”模式:**\n\n
\n\n## 工作方式\n\n你需要一台可以连接到的服务器来代理网络请求。\n\n**对于SOCKS协议**\n\n\n\n**对于SS协议**\n\n\n\n目前支持ss协议的客户端较较多，因此你可以直接在服务器上同时启动一个ss协议的client和server来支持这些设备。但直接连接服务器上的client会没办法发挥kcp的优势。\n\n**protocol(unstable):**\n\n**NOTE:** 在nysocks v2.0.0中协议发生了改变，请确保客户端和服务器的版本都在该版本之上.\n\n```\n+-------+-----+-----+---------+---------+--------+------------+\n| kcp | ver | cmd | nonce | mux.cmd | mux.id | mux.length |\n+-------+-----+-----+---------+---------+--------+------------+\n| 24 | 1 | 1 | 8 | 1 | 2 | 4 |\n+-------+-----+-----+---------+---------+--------+------------+\n```\n\n## 安装\n\n`node >= v6.x`\n\n**请确保[node-gyp](https://github.com/nodejs/node-gyp#installation)可用**。\n\n```\nnpm i nysocks -g\n```\n\n## 使用\n\n#### 1. 创建server\n\n在你的服务器上，执行`server`命令:\n\n```\nnysocks server -p 20000 -k YOUR_PASSWORD -m fast\n```\n\n#### 2 创建client\n\n在你的客户端上，执行`client`命令连接到你的`server`上。之后`client`就可以对本地的其他应用提供代理服务了：\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast\n```\n\n执行完上述命令后，当你的`client`显示`SOCKS5 service is listening on 1080`后，你就可以[利用SOCKS5协议](https://github.com/oyyd/nysocks#how-to-utilize-the-socks5-service)来进行代理了。nysocks的client同时会提供一个[PAC](https://en.wikipedia.org/wiki/Proxy_auto-config)（默认端口`8090`）文件服务来帮助你的应用确定哪些请求不需要转发。\n\n**SS协议client**\n\n你可以开启ss协议的client来代替SOCKS5协议：\n\n```\nnysocks client -a YOUR_SERVER_HOST -p 20000 -k YOUR_PASSWORD -m fast --client_protocol SS --ss_password YOUR_SS_PASSWORD --ss_method aes-128-cfb\n```\n\n关于nysocks中ss协议的实现，可以直接参考[encryptsocks](https://github.com/oyyd/encryptsocks) 中ssServer的实现。\n\n#### 3. 用`config.json`文件\n\n类似与ss，你可以将配置数据储存在`config.json`文件中，像[这里](#config)，以避免繁琐的命令行参数：\n\n```\nnysocks client -c config.json\n```\n\n#### 4. 开启守护进程\n\n在实际使用时，你可以利用`-d`选项让client和server运行在守护进程下，以便在发生问题以后自动重启：\n\n```\nnysocks client -d restart -c config.json\n```\n\nnysock使用[pm2](http://pm2.keymetrics.io/)进行进程守护，你也可以通过nysocks命令行直接操作pm2，如查看正在运行的进程：\n\n```\nnysocks pm -- ls\n```\n\n清除所有的进程：\n\n```\nnysocks pm -- kill\n```\n\n#### 5. 查看其他配置项\n\n你可以直接在命令行工具上查看所有可用的配置项:\n\n```\nnysocks -h\n```\n\n## 可用配置\n\n```\nnysocks