bin | ||
build | ||
deploy | ||
docs | ||
src | ||
.babelrc | ||
.dockerignore | ||
.eslintrc | ||
.gitignore | ||
.smooth-releaserc | ||
.travis.yml | ||
AUTHORS | ||
CHANGELOG.md | ||
LICENSE | ||
package.json | ||
README.md | ||
webpack.config.js | ||
yarn.lock |
blinksocks
A framework for building composable proxy protocol stack. Inspired by Shadowsocks, and ShadowsocksR.
Features
- HTTP/Socks5/Socks4/Socks4a using the same port
- Customizable Protocols(presets): simple, composable, and flexible
- Cross-platform: running on Linux based, Windows and macOS
- Partially compatible with shadowsocks #27
- Dynamic server switch
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, so please install Node.js(greater than v6.x) on your operating system.
Install or Upgrade
You can get the latest pre-compiled library(including executables) of blinksocks from yarn or npm.
NOTE: Node.js comes with npm installed so you don't have to install npm individually.
$ npm install -g blinksocks
Without Install?
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
$ blinksocks client -c blinksocks.client.json
portable version
$ node blinksocks.js -c blinksocks.client.json
For configuring blinksocks, please refer to Configuration.
Documents
For Users
For Developers
Contributors
See authors.
License
Apache License 2.0