kumasocks

command module
v0.0.0-...-a30116d Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2024 License: MIT Imports: 13 Imported by: 0

README

KumaSocks

A light-weighted transparent proxy to socks5 converter written in Golang, inspired by Transocks.

Usage

You should create a file for the config, using the TOML format.

listen-addr = "0.0.0.0:1234"
proxy-addr = "socks5://192.168.1.210:1080"

The default conf file is located at /etc/kumasocks.toml. You can customize it using the -c parameter.

Then you can use iptables redirect to route traffics to KumaSocks, and it will directly route them to the socks5 server. Be aware, there is no encryption. Use at your own risk!

You can refer to this page to find detailed instructions. (Chinese only)

Advanced Usage

When you want to run KumaSocks on some embedded devices, such as routers, you can reduce the size of executables by using following build command.

go build -ldflags "-s -w"

When you want to make KumaSocks more smaller, you can consider to use upx. Here is the command.

upx --best KumaSocks

FAQS

If you have problems with splice in Linux, try to turn on the io-copy-hack option in config file. It will reduce the performance as it is using a custom version of io.Copy without using splice system call.

Documentation

Overview

KumaSocks document

KumaSocks project main.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL