moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
687 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
81a25e4c35
Go to file
Micooz 81a25e4c35 core: fix presets in relay.js
2017-08-21 22:15:02 +08:00
benchmark benchmark: use tunnel preset 2017-08-18 15:44:34 +08:00
bin bin: change "transport" structure 2017-08-21 18:10:25 +08:00
build build: update 2017-08-20 22:08:18 +08:00
deploy deploy: fix pm2.config.json 2017-08-20 20:14:41 +08:00
docs docs: update 2017-08-21 18:09:57 +08:00
pkg package,pkg: integrate pkg, add postpkg.js 2017-08-09 14:56:54 +08:00
src core: fix presets in relay.js 2017-08-21 22:15:02 +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 git: ignore pem files 2017-08-21 21:10:12 +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.5.3 2017-08-16 13:34:35 +08:00
LICENSE chore(License): update copyright to 2017 2017-01-02 23:14:59 +08:00
package.json package: add lodash.uniqueid 2017-08-21 18:03:52 +08:00
README.md docs: update 2017-08-20 17:13:57 +08:00
webpack.config.js benchmark: remove "watch" option 2017-08-14 22:03:34 +08:00
yarn.lock package: add lodash.uniqueid 2017-08-21 18:03:52 +08:00

README.md

blinksocks

version downloads license dependencies devDependencies

Travis Coverage %e2%9d%a4

A framework for building composable proxy protocol stack.

Features

  • Simple proxy interfaces for Socks5/Socks4/Socks4a and HTTP
  • Customizable Protocols(using presets): simple, composable, and flexible
  • Cross-platform: running on Linux based, Windows and macOS
  • Portable/Executable versions available
  • Partially compatible with shadowsocks #27

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, if you want to use it in an ordinary way or do some hacking, please install Node.js(v6.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.

stable version

$ npm install -g blinksocks

unstable version

$ npm install -g blinksocks@next

Without yarn or npm?

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

the latest build(maybe unstable)

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

previous build(with tag in url, stable)

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

Run blinksocks

npm version(require Node.js)

$ blinksocks -c blinksocks.client.json

portable version(require Node.js)

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

executable version(Node.js, not GUI)

$ ./blinksocks(.exe) --help

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

For configuring blinksocks, please refer to Configuration.

Documents

For Users

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

For Developers

  1. Steps
  2. Principle
  3. Architecture
  4. Benchmark

Contributors

See authors.

License

Apache License 2.0