moony/blinksocks
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
580 Commits 2 Branches 41 Tags 4.3 MiB
JavaScript 99.7%
Shell 0.3%
5d4bd8c3a9
Go to file
Micooz 5d4bd8c3a9 core,presets: switch to use SOCKET_CONNECT_TO_REMOTE
2017-08-10 22:09:00 +08:00
bin core,bin: remove profile.js 2017-08-10 14:31:29 +08:00
build build: update 2017-08-10 14:37:50 +08:00
deploy deploy: use node:6.11.2-slim in Dockerfile 2017-08-07 22:05:42 +08:00
docs docs: update presets 2017-08-10 17:42:45 +08:00
pkg package,pkg: integrate pkg, add postpkg.js 2017-08-09 14:56:54 +08:00
src core,presets: switch to use SOCKET_CONNECT_TO_REMOTE 2017-08-10 22:09:00 +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.5.0 2017-08-09 15:28:09 +08:00
LICENSE chore(License): update copyright to 2017 2017-01-02 23:14:59 +08:00
package.json package: remove commander 2017-08-09 22:45:39 +08:00
README.md docs: update config and usage 2017-08-10 09:13:22 +08:00
webpack.config.js test: lint pkg as well 2017-08-09 14:55:42 +08:00
yarn.lock package: remove lodash.isequal, add pkg and rimraf 2017-08-09 14:24:46 +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.

Executables ready(Not GUI)

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

Download

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.

$ npm install -g blinksocks

Without yarn or npm?

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(require Node.js)

$ blinksocks -c blinksocks.client.json

portable version(require Node.js)

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

executable version(Node.js)

$ ./blinksocks(.exe) --help

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