Skip to content

A framework for building composable proxy protocol stack.

License

Notifications You must be signed in to change notification settings

Xarrow/blinksocks

 
 

Repository files navigation

blinksocks

version downloads license dependencies devDependencies

Travis Coverage %e2%9d%a4

A framework for building composable proxy protocol stack.

Features

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(v8.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)

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

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

For configuring blinksocks, please refer to Configuration.

Documents

For Users

  1. Usage
  2. Configuration
  3. Presets

For Developers

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

Contributors

See contributors.

License

Apache License 2.0

About

A framework for building composable proxy protocol stack.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.8%
  • Shell 0.2%