moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
548 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
d397f28f7c
Go to file
Micooz d397f28f7c docs: update config
2017-08-08 15:40:19 +08:00
bin Merge branch 'feature-using-webpack' 2017-08-08 14:50:14 +08:00
build index.js: fix argv check 2017-08-08 15:34:40 +08:00
deploy deploy: use node:6.11.2-slim in Dockerfile 2017-08-07 22:05:42 +08:00
docs docs: update config 2017-08-08 15:40:19 +08:00
src index.js: fix argv check 2017-08-08 15:34:40 +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 package: add webpack, webpack.config.js and loaders 2017-08-07 22:12:33 +08:00
.smooth-releaserc chore(release): deprecate "github_changelog_generator", integrate "smooth-release" 2017-05-24 12:50:29 +08:00
.travis.yml travis: use node_js v6.11.2 2017-08-07 22:05:01 +08:00
AUTHORS chore(): add AUTHORS and CHANGELOG.md 2017-03-18 15:54:16 +08:00
CHANGELOG.md 2.4.9 2017-08-04 15:03:02 +08:00
LICENSE chore(License): update copyright to 2017 2017-01-02 23:14:59 +08:00
package.json package: update description and keywords 2017-08-08 15:17:23 +08:00
README.md docs: update 2017-08-08 15:17:40 +08:00
webpack.config.js webpack: update webpack.config.js 2017-08-08 14:04:49 +08:00
yarn.lock package: rebuild yarn.lock 2017-08-08 14:51:46 +08:00

README.md

blinksocks

version downloads license dependencies devDependencies

Travis Coverage %e2%9d%a4

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.

Getting Started

Requirements

blinksocks is built on top of Node.js, so please install Node.js(greater than v6.x) on your operating system.

Install or Upgrade

You can get the latest pre-compiled library(including executables) of blinksocks from yarn or npm.

NOTE: Node.js comes with npm installed so you don't have to install npm individually.

$ npm install -g blinksocks

Without Install?

If you hate to install and want to get a even more portable version, we have one:

$ wget https://raw.githubusercontent.com/blinksocks/blinksocks/master/build/blinksocks.js

Run blinksocks

installed version

$ blinksocks client -c blinksocks.client.json

portable version

$ node blinksocks.js -c blinksocks.client.json

For configuring blinksocks, please refer to Configuration.

Documents

For Users

  1. Usage
  2. Configuration
  3. Presets

For Developers

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

Contributors

See authors.

License

Apache License 2.0