Go to file

Micooz 4bffddf7b3 lib: regen		2018-02-16 17:01:37 +08:00
.github	add ISSUE_TEMPLATE.md	2017-08-22 20:18:34 +08:00
benchmark	chore: remove .gitignore from sub directories	2018-02-09 12:03:55 +08:00
bin	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00
deploy	deploy: use latest Node.js v8	2017-12-13 10:14:36 +08:00
docs	docs: add config.json example	2018-02-08 13:40:30 +08:00
lib	lib: regen	2018-02-16 17:01:37 +08:00
pkg	chore: remove .gitignore from sub directories	2018-02-09 12:03:55 +08:00
src	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00
suites	docs: update	2018-02-03 22:43:37 +08:00
test	test: rewrite e2e tests to simulate real running environment	2018-02-16 17:01:37 +08:00
.babelrc	chore(lib): compile to higher node version	2017-04-14 10:29:48 +08:00
.dockerignore	feat(deploy): add Docker stuff	2016-12-31 23:03:46 +08:00
.eslintignore	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00
.eslintrc	chore(eslint): turn off no-undef and max-len check rules	2017-02-20 22:58:43 +08:00
.gitignore	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00
.travis.yml	ci: include commit hash in package version	2018-02-10 10:52:31 +08:00
CHANGELOG.md	changlog: update	2018-02-03 23:47:10 +08:00
crowdin.yml	Update Crowdin configuration file	2018-02-14 12:47:03 +08:00
LICENSE	license: 2018	2018-01-01 21:49:10 +08:00
package.json	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00
README.md	docs: add link to blinksocks-nightly-releases	2018-02-09 16:03:36 +08:00
yarn.lock	src: bugfixs and improvements	2018-02-16 17:01:37 +08:00

README.md

blinksocks

A framework for building composable proxy protocol stack.

Features

Cross-platform: running on Linux, Windows and macOS.
Lightweight proxy interface for Socks5/Socks4/Socks4a and HTTP(S).
Transmit data over TCP/UDP, TLS or WebSocket.
Multiplexing over TCP/TLS/WS.
A variety of customizable protocols and functional middlewares: using presets.
External preset import.
Easy and powerful Access Control(ACL) and Traffic Control(TC).
Support shadowsocks, shadowsocksR, v2ray vmess protocols.
Out of the box distribution and deployment.
Experimental: dynamic protocol stack.
Portable versions are available: download here.

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

nightly releases

Please check out blinksocks-nightly-releases.

Run blinksocks

npm version(require Node.js)

$ blinksocks --help

executable version(~~Node.js~~, not GUI)

$ ./blinksocks --help    // Linux and macOS
$ blinksocks.exe --help  // Windows

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

For configuring blinksocks, please refer to Configuration.

GUI ready(out-of-date)

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

README.md

blinksocks

Features

Getting Started

Requirements

Install or Upgrade

Run blinksocks

GUI ready(out-of-date)

Documents

For Users

For Developers

Contributors

License