moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
757 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
6349929891
Go to file
Micooz 6349929891
docs: update blinksocks.png
2017-09-05 17:56:51 +08:00
.github add ISSUE_TEMPLATE.md 2017-08-22 20:18:34 +08:00
benchmark benchmark: remove "log_path" 2017-09-02 21:28:21 +08:00
bin bin: update usage 2017-09-05 17:56:00 +08:00
build build,lib: update 2017-09-02 21:35:49 +08:00
deploy deploy: fix pm2.config.json 2017-08-20 20:14:41 +08:00
docs docs: update blinksocks.png 2017-09-05 17:56:51 +08:00
lib lib: update 2017-09-05 14:52:25 +08:00
pkg package,pkg: integrate pkg, add postpkg.js 2017-08-09 14:56:54 +08:00
src presets: adjust presets order 2017-09-05 17:55: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
.eslintrc chore(eslint): turn off no-undef and max-len check rules 2017-02-20 22:58:43 +08:00
.gitignore git: fix ignore 2017-08-22 11:01:29 +08:00
.travis.yml travis: use node_js v6.11.2 2017-08-07 22:05:01 +08:00
AUTHORS chore(): add AUTHORS and CHANGELOG.md 2017-03-18 15:54:16 +08:00
CHANGELOG.md 2.5.4 2017-08-22 11:13:43 +08:00
LICENSE *: fix mode 2017-08-31 18:01:28 +08:00
package-lock.json package: add package-lock.json 2017-09-02 11:20:59 +08:00
package.json package: update deps 2017-09-05 14:29:24 +08:00
README.md docs: update 2017-09-05 14:36:33 +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 deps 2017-09-05 14:29:24 +08:00

README.md

blinksocks

version downloads license dependencies devDependencies

Travis %e2%9d%a4

A framework for building composable proxy protocol stack.

Features

  • Cross-platform: running on Linux, Windows and macOS.
  • Simple proxy interface for Socks5/Socks4/Socks4a and HTTP.
  • Transmit over TCP or TLS.
  • Customizable protocols and functional middlewares: using presets.
  • Over 30+ built-in combinations with benchmark.
  • Easy and powerful Access Control(ACL): auto ban, speed limiter.
  • Portable/Executable versions available: download here.
  • Compatible with shadowsocks(partially). #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

  1. Usage
  2. Configuration
  3. Presets
  4. Behaviours

For Developers

  1. Steps
  2. Principle
  3. Architecture
  4. Benchmark

Contributors

See authors.

License

Apache License 2.0