blinksocks/README.md

blinksocks

A framework for building composable proxy protocol stack.

Features

• Simple proxy interfaces for Socks5/Socks4/Socks4a and HTTP
• Customizable Protocols(using presets): simple, composable, and flexible
• Cross-platform: running on Linux based, Windows and macOS
• Portable/Executable versions available
• Partially compatible with shadowsocks #27

GUI ready

For desktop use, you can download official blinksocks-desktop, a cross-platform GUI for blinksocks.

Executables ready(Not GUI)

You can download precompiled executables for different platforms and use it directly without having Node.js installed:

Download

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(v6.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.

$ npm install -g blinksocks

Without yarn or npm?

If you hate to install and want to get a even more portable version, we have one:

$ wget https://raw.githubusercontent.com/blinksocks/blinksocks/master/build/blinksocks.js

Run blinksocks

installed version(require Node.js)

$ blinksocks client -c blinksocks.client.json

portable version(require Node.js)

$ node blinksocks.js -c blinksocks.client.json

executable version(Node.js)

$ ./blinksocks(.exe) --help

For configuring blinksocks, please refer to Configuration.

Documents

For Users

1. Usage
2. Configuration
3. Presets

For Developers

1. Steps
2. Principle
3. Architecture
4. Performance (outdated)

Contributors

See authors.

License

Apache License 2.0