3.0 KiB
3.0 KiB
blinksocks
A framework for building composable proxy protocol stack.
Looking for GUI? Here it is: https://github.com/blinksocks/blinksocks-gui
Features
- Cross-platform: running on Linux, Windows and macOS.
- Lightweight proxy interfaces: Socks5/Socks4/Socks4a and HTTP.
- Multiple Transport Layers: TCP, UDP, TLS and WebSocket.
- TLS/TLS/WebSocket multiplexing.
- Convenient protocol customization.
- Access Control List(ACL) support.
- Built-In shadowsocks, shadowsocksR, v2ray vmess protocols.
- Out of the box distribution and deployment.
Getting Started
Requirements
blinksocks is built on top of Node.js, if you want to use it in an ordinary way or do some hacking, please install Node.js(v8.x and above) on your operating system.
Install or Upgrade
You can get the latest blinksocks via package manager yarn or npm.
NOTE: Node.js comes with npm installed so you don't have to install npm individually.
latest stable version
$ npm install -g blinksocks
nightly releases
Please check out blinksocks-nightly-releases.
Run blinksocks
$ blinksocks --help
For configuring blinksocks, please refer to Configuration.
Documents
For Users
For Developers
Contributors
See contributors.
License
Apache License 2.0