3.6 KiB
blinksocks
A framework for building composable proxy protocol stack.
Features
- Simple proxy interface for Socks5/Socks4/Socks4a and HTTP.
- Cross-platform: running on Linux, Windows and macOS.
- Transmit over TCP or TLS.
- Customizable protocols and middlewares: using Presets.
- Customizable relay behaviours: using Behaviours.
- Portable/Executable versions available. Download Here
- Partially compatible with shadowsocks. #27
GUI ready
For desktop use, you can download official blinksocks-desktop, a cross-platform GUI for blinksocks.
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.
latest stable version
$ npm install -g blinksocks
developing version
$ npm install -g git+https://github.com/blinksocks/blinksocks.git
$ npm install -g git+https://github.com/blinksocks/blinksocks.git#v2.5.5
Without yarn or npm?
If you hate to install and want to get a even more portable version, we have all in one script:
the latest build(maybe unstable)
$ wget https://raw.githubusercontent.com/blinksocks/blinksocks/master/build/blinksocks.js
previous build(with tag in url, stable)
$ wget https://raw.githubusercontent.com/blinksocks/blinksocks/v2.5.1/build/blinksocks.js
Run blinksocks
npm version(require Node.js)
$ blinksocks -c blinksocks.client.json
portable version(require Node.js)
$ node blinksocks.js -c blinksocks.client.json
executable version(Node.js, not GUI)
$ ./blinksocks(.exe) --help
You can download precompiled executables for different platforms and launch it directly without having Node.js installed.
For configuring blinksocks, please refer to Configuration.
Documents
For Users
For Developers
Contributors
See authors.
License
Apache License 2.0