moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
1,300 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
3024cccf5a
Go to file
Micooz 3024cccf5a package,docs: drop executable support
2018-06-10 14:28:32 +08:00
.github add ISSUE_TEMPLATE.md 2017-08-22 20:18:34 +08:00
benchmark benchmark: add 2018-05-01.txt 2018-05-01 21:59:59 +08:00
bin presets: refactor index.js 2018-06-02 09:55:11 +08:00
deploy deploy: add install-run-debian.sh 2018-06-10 10:34:36 +08:00
docs package,docs: drop executable support 2018-06-10 14:28:32 +08:00
lib package,docs: drop executable support 2018-06-10 14:28:32 +08:00
src presets: refactor index.js 2018-06-02 09:55:11 +08:00
test test: add tests for speed-tester.js and presets/index.js 2018-06-02 09:54:31 +08:00
.babelrc lib: make compile target to Node.js 8 2018-02-28 13:29:06 +08:00
.dockerignore feat(deploy): add Docker stuff 2016-12-31 23:03:46 +08:00
.eslintrc eslint: enable "no-undef" and "object-curly-spacing" 2018-03-30 12:09:48 +08:00
.gitignore package: upgrade winston and winston-daily-rotate-file to v3.x, restrict log_path to be a file 2018-03-18 12:50:38 +08:00
.travis.yml ci: change NEXT_VERSION to 3.3.0 2018-06-10 10:32:42 +08:00
CHANGELOG.md package: bump to v3.2.1 2018-05-12 16:45:47 +08:00
LICENSE license: 2018 2018-01-01 21:49:10 +08:00
package-lock.json package,docs: drop executable support 2018-06-10 14:28:32 +08:00
package.json package,docs: drop executable support 2018-06-10 14:28:32 +08:00
README.md package,docs: drop executable support 2018-06-10 14:28:32 +08:00

README.md

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

  • Cross-platform: running on Linux, Windows and macOS.
  • Lightweight proxy interfaces: Socks5/Socks4/Socks4a and HTTP.
  • Multiple Transport Layers: TCP, UDP, TLS and WebSocket.
  • TLS/TLS/WebSocket multiplexing.
  • Convenient protocol customization.
  • Access Control List(ACL) support.
  • Built-In shadowsocks, shadowsocksR, v2ray vmess protocols.
  • Out of the box distribution and deployment.

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

$ blinksocks --help

For configuring blinksocks, please refer to Configuration.

Documents

For Users

  1. Usage
  2. Configuration
  3. Presets

For Developers

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

Contributors

See contributors.

License

Apache License 2.0