blinksocks

A framework for building composable proxy protocol stack. Inspired by Shadowsocks, and ShadowsocksR.

Features

• HTTP/Socks5/Socks4/Socks4a using the same port
• Customizable Protocols(presets): simple, composable, and flexible
• Cross-platform: running on Linux based, Windows and macOS
• Partially compatible with shadowsocks #27
• Dynamic server switch

GUI ready

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

Quick Start

$ blinksocks client -c blinksocks.client.js

// blinksocks.client.js
module.exports = {
  host: "localhost",
  port: 1080,
  servers: [{
    enabled: true,
    transport: 'tcp',
    host: "bs.example.com",
    port: 6858,
    key: "qtPb2edK7yd7e]<K",
    presets: [
      {name: "ss-base", params: {}},
      {name: "ss-aead-cipher", params: {method: "aes-256-gcm", info: "ss-subkey"}}
    ]
  }],
  dns: ['8.8.8.8'],
  timeout: 600,
  profile: false,
  watch: true,
  log_level: "info"
};

Documents

For Users

1. Getting Started
2. Usage
3. Configuration
4. Presets

For Developers

1. Steps
2. Principle
3. Architecture
4. Performance (outdated)

Contributors

See authors.

License

Apache License 2.0