moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
921 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
889b2bd6e6
Go to file
Micooz 889b2bd6e6 src: refine api interfaces
2017-10-21 11:57:58 +08:00
.github add ISSUE_TEMPLATE.md 2017-08-22 20:18:34 +08:00
benchmark benchmark: add 2017-10-17.txt 2017-10-17 16:16:46 +08:00
bin src: refine api interfaces 2017-10-21 11:57:58 +08:00
deploy ci,deploy: use Node.js v6.11.4 2017-10-13 14:09:42 +08:00
docs docs: update 2017-10-21 10:59:59 +08:00
lib lib: update 2017-10-17 16:17:26 +08:00
pkg package,pkg: integrate pkg, add postpkg.js 2017-08-09 14:56:54 +08:00
src src: refine api interfaces 2017-10-21 11:57:58 +08:00
test core: move middleware creation from relay to pipe 2017-10-20 10:53:11 +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 changelog: update 2017-10-17 16:14:11 +08:00
LICENSE *: fix mode 2017-08-31 18:01:28 +08:00
package.json package: update deps 2017-10-19 11:06:08 +08:00
README.md docs: update 2017-10-21 10:59:59 +08:00
yarn.lock package: update deps 2017-10-19 11:06:08 +08:00

README.md

blinksocks

version downloads license dependencies devDependencies

Travis Coverage %e2%9d%a4

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.
  • External preset import.
  • Easy and powerful Access Control(ACL) and Traffic Control(TC): auto ban, speed(upload/download) limiter.
  • Executable versions available: download here.
  • Out of the box distribution and deployment.
  • Compatible with shadowsocks.
  • Compatible with v2ray vmess.

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

Run blinksocks

npm version(require Node.js)

$ blinksocks -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(out-of-date)

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

Documents

For Users

  1. Usage
  2. Configuration
  3. Presets

For Developers

  1. Preparation
  2. Guideline
  3. Custom Preset
  4. Benchmark

Contributors

See authors.

License

Apache License 2.0