Skip to content

blinksocks/blinksocks

Repository files navigation

blinksocks

version downloads license dependencies devDependencies

Travis Coverage %e2%9d%a4

A framework for building composable proxy protocol stack.

Looking for GUI? Here it is: https://github.com/blinksocks/blinksocks-gui

Features

Getting Started

Requirements

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.

$ npm install -g blinksocks

Run blinksocks

$ blinksocks --help

For configuring blinksocks, please refer to Configuration.

Documents

For Users

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

For Developers

  1. Preparation
  2. Architecture
  3. API
  4. Benchmark

Contributors

See contributors.

License

Apache License 2.0