Code Monkey home page Code Monkey logo

kcptun-plugins's Introduction

KCPTUN Plugins

This repository features:

  • SIP003-compatible KCPTUN and UDP2RAW plugins for Shadowsocks
  • One-key setup of Shadowsocks+KCPTUN+UDP2RAW
  • Automatic upgrade of latest KCPTUN and UDP2RAW binaries
  • IPv6 support

Usage

Install:

# make install

Server:

ss-server ... --plugin kcptun-server-plugin --plugin-opts "key=YOUR_KEY;raw=YES"

Client:

ss-local ... --plugin kcptun-client-plugin --plugin-opts "key=YOUR_KEY;raw=YES"

Client for proxying only:

ss-proxy -s Server_IP -p Server_Port -l Local_Port --plugin kcptun-client-plugin --plugin-opts "key=YOUR_KEY;raw=YES"

Upgrade binaries:

kcptun-server-plugin upgrade
kcptun-client-plugin upgrade

Upgrade binaries with proxychains-ng:

PROXY=proxychains4 kcptun-server-plugin upgrade
PROXY=proxychains4 kcptun-client-plugin upgrade

Note: you may also place predownloaded archives in /tmp if the network condition is really bad.

Plugin Options

KCPTUN:

  • config: KCPTUN config. Override all other KCPTUN options. (-c)
  • key: KCPTUN and UDP2RAW encryption key (--key)
  • crypt: KCPTUN encryption (--crypt)
  • mode: KCPTUN mode (--mode)
  • mtu: KCPTUN MTU (--mtu)
  • sndwnd: KCPTUN send window (--sndwnd)
  • rcvwnd: KCPTUN receive window (--rcvwnd)
  • datashard: KCPTUN datashard (--datashard)
  • parityshard: KCPTUN parityshard (--parityshard)
  • dscp: KCPTUN dscp (--dscp)
  • nocomp: YES to disable KCPTUN compression (--nocomp)
  • quiet: YES to suppress KCPTUN output (--quiet)
  • params: specify other parameters like params=\"--log /tmp/kcptun.err.log\"

UDP2RAW:

  • raw: YES to enable UDP2RAW
  • raw_config: UDP2RAW config. Override all other UDP2RAW options. (--conf-file)
  • raw_mode: UDP2RAW mode (--raw-mode)
  • key: KCPTUN and UDP2RAW encryption key (--key)
  • raw_cipher: UDP2RAW cipher mode (--cipher-mode)
  • raw_auth: UDP2RAW auth mode (--auth-mode)
  • raw_params: specify other parameters like raw_params=\"--seq-mode 0\"

Todo

  • Support for multiple interface binding

Related Projects

kcptun-plugins's People

Contributors

btstream avatar w1ndy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

kcptun-plugins's Issues

How to?

So how to set up KCP+SS+UDP2RAW properly on server using this script and how to make it work on my windows client side? Someone explains me, please. Don't get it.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.