Go to file

Micooz 6200a9ce9a core: add "dstaddr" option to config.js		2017-10-14 22:47:09 +08:00
.github	add ISSUE_TEMPLATE.md	2017-08-22 20:18:34 +08:00
benchmark	benchmark: refactor makeConfs	2017-10-14 22:46:41 +08:00
bin	bin: fix TypeError: modules.presets.join is not a function	2017-10-14 13:02:34 +08:00
build	lib,build: update	2017-10-13 17:35:10 +08:00
deploy	ci,deploy: use Node.js v6.11.4	2017-10-13 14:09:42 +08:00
docs	docs: update	2017-10-13 17:29:32 +08:00
lib	lib,build: update	2017-10-13 17:35:10 +08:00
pkg	package,pkg: integrate pkg, add postpkg.js	2017-08-09 14:56:54 +08:00
src	core: add "dstaddr" option to config.js	2017-10-14 22:47:09 +08:00
test	presets: remove tunnel	2017-10-14 22:28:06 +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
.eslintrc	chore(eslint): turn off no-undef and max-len check rules	2017-02-20 22:58:43 +08:00
.gitignore	ci: fix	2017-09-14 17:47:36 +08:00
.travis.yml	ci,deploy: use Node.js v6.11.4	2017-10-13 14:09:42 +08:00
AUTHORS	chore(): add AUTHORS and CHANGELOG.md	2017-03-18 15:54:16 +08:00
CHANGELOG.md	package: bump to v2.6.3	2017-10-09 13:46:54 +08:00
LICENSE	*: fix mode	2017-08-31 18:01:28 +08:00
package.json	package: update webpack	2017-10-13 15:45:48 +08:00
README.md	docs: update	2017-10-13 17:29:32 +08:00
webpack.config.js	package: replace babili-webpack-plugin to babel-minify-webpack-plugin	2017-09-02 11:20:01 +08:00
yarn.lock	package: update yarn.lock	2017-10-13 15:58:09 +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 raw TCP, real TLS or real WebSocket.
A variety of customizable protocols and functional middlewares: using presets.
Easy and powerful Access Control(ACL) and Traffic Control(TC): auto ban, speed(upload/download) limiter.
Portable/Executable versions available: download here.
Out of the box distribution and deployment.
Compatible with shadowsocks (partially).
Compatible with v2ray vmess (partially).

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

development 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(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 --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

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

Without yarn or npm?

Run blinksocks

GUI ready

Documents

For Users

For Developers

Contributors

License