zousandian / blinksocks

A framework for building composable proxy protocol stack.

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/HTTPS.
• Transport Layer Support: TCP, UDP, TLS, HTTP2, WebSocket and WebSocket/TLS.
• TCP/TLS/HTTP2/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

• Node.js v8.4.x and above.

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.

$ npm install -g blinksocks

Run blinksocks

$ blinksocks --help

For configuring blinksocks, please refer to Configuration.

Documents

For Users

1. Usage
2. Configuration
3. Presets
4. Examples

For Developers

1. Preparation
2. Architecture
3. API
4. Benchmark

Contributors

See contributors.

License

Apache License 2.0