kobeyoung81/shadowsocks-go repository overview

⁠shadowsocks-go

Current version: 1.2.2

shadowsocks-go is a lightweight tunnel proxy which can help you get through firewalls.

The protocol is compatible with the origin shadowsocks (if both have been upgraded to the latest version).

This docker image contains the server side program. Ideal for setting up a shadowsocks server deployment.

⁠Usage

docker run -d --name tryss -p 10777:8080/tcp -e PORT=8080 -e PASSWORD=secret -e METHOD=aes-128-cfb -e TIMEOUT=500 kobeyoung81/shadowsocks-go 

Configurations are set through environment variable, you can change the following values:

PORT     	server port
METHOD   	encryption method, null by default (table), the following methods are supported:
              aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, cast5-cfb, des-cfb, rc4-md5, rc4-md5-6, chacha20, salsa20, rc4, table
PASSWORD 	a password used to encrypt transfer 
TIMEOUT   server option, in seconds

⁠About encryption methods

AES is recommended for shadowsocks-go. Intel AES Instruction Set⁠ will be used if available and can make encryption/decryption very fast. To be more specific, aes-128-cfb is recommended as it is faster and secure enough⁠.

rc4 and table encryption methods are deprecated because they are not secure.

⁠Startup command

The following sh command is invoked during container startup:

shadowsocks-server -p $PORT -k $PASSWORD -m $METHOD -t $TIMEOUT

⁠中文介绍

shadowsocks-go 是一个用于绕开防火墙限制的轻量级管道代理。这个由go语言实现的版本与原始的shadowsocks协议保持兼容，各个常见的shadowsocks客户端可以正常连接使用。

本docker容器封装了服务端程序，可以很方便的在服务器上部署shadowsocks服务端容器。

⁠启动容器

docker run -d --name tryss -p 10777:8080/tcp -e PORT=8080 -e PASSWORD=secret -e METHOD=aes-128-cfb -e TIMEOUT=500 kobeyoung81/shadowsocks-go 

配置项通过环境变量进行设置：

PORT     	服务端容器内端口，注意同主机端口进行映射
METHOD   	加密方法, 支持如下加密，推荐aes-128-cfb:
              aes-128-cfb, aes-192-cfb, aes-256-cfb, bf-cfb, cast5-cfb, des-cfb, rc4-md5, rc4-md5-6, chacha20, salsa20
PASSWORD 	客户端连接密码 
TIMEOUT   服务端选项，超时时间

⁠启动命令

在容器内是通过以下 sh 命令启动服务端程序

shadowsocks-server -p $PORT -k $PASSWORD -m $METHOD -t $TIMEOUT