teddysun/shadowsocks-rust repository overview

⁠Shadowsocks-rust Docker Image by Teddysun

shadowsocks-rust⁠ is a fast tunnel proxy that helps you bypass firewalls.

It is a port of shadowsocks⁠ created by @zonyitoo⁠.

Based on alpine with latest version shadowsocks-rust⁠ and v2ray-plugin⁠, xray-plugin⁠.

Docker images are built for quick deployment in various computing cloud providers. For more information on docker and containerization technologies, refer to official document⁠.

⁠Supported tags and respective Dockerfile links

• latest, 1.24.0, debian , debian-1.24.0 (Dockerfile)⁠

• 1.23.5, 1.23.4, 1.23.3, 1.23.2, 1.23.0,1.22.0,1.21.2, debian-1.23.5, debian-1.23.4, debian-1.23.3, debian-1.23.2, debian-1.23.0, debian-1.22.0, debian-1.21.2

• 1.20.3, 1.20.2, 1.20.1, 1.20.0, debian-1.20.3, debian-1.20.2, debian-1.20.1, debian-1.20.0

• 1.19.4, 1.19.2, 1.19.0, debian-1.19.4, debian-1.19.2, debian-1.19.0

• 1.18.4, 1.18.3, 1.18.2, 1.18.1, 1.18.0, debian-1.18.4, debian-1.18.3,debian-1.18.2,debian-1.18.1, debian-1.18.0

• alpine, alpine-1.24.0 (Dockerfile)⁠

• alpine-1.23.5, alpine-1.23.4, alpine-1.23.3, alpine-1.23.2, alpine-1.23.0, alpine-1.22.0, alpine-1.21.2

• alpine-1.20.3, alpine-1.20.2, alpine-1.20.1, alpine-1.20.0

• alpine-1.19.4, alpine-1.19.2, alpine-1.19.0

• alpine-1.18.4, alpine-1.18.3, alpine-1.18.2, alpine-1.18.1, alpine-1.18.0

⁠Reference

• Supported architectures (more info⁠): amd64, arm32v6, arm32v7, arm64v8

⁠Prepare the host

If you need to install docker by yourself, follow the official installation guide⁠.

⁠Pull the image

$ docker pull teddysun/shadowsocks-rust

This pulls the latest release of shadowsocks-rust.

It can be found at Docker Hub⁠.

⁠Start a container

You must create a configuration file /etc/shadowsocks-rust/config.json in host at first:

$ mkdir -p /etc/shadowsocks-rust

A sample in JSON like below:

$ cat > /etc/shadowsocks-rust/config.json <<EOF
{
    "server":"0.0.0.0",
    "server_port":9000,
    "password":"password0",
    "timeout":300,
    "method":"aes-256-gcm",
    "nameserver":"8.8.8.8",
    "mode":"tcp_and_udp"
}
EOF

If you want to enable v2ray-plugin, a sample in JSON like below:

$ cat > /etc/shadowsocks-rust/config.json <<EOF
{
    "server":"0.0.0.0",
    "server_port":9000,
    "password":"password0",
    "timeout":300,
    "method":"aes-256-gcm",
    "nameserver":"8.8.8.8",
    "mode":"tcp_and_udp",
    "plugin":"v2ray-plugin",
    "plugin_opts":"server"
}
EOF

If you want to enable xray-plugin, a sample in JSON like below:

$ cat > /etc/shadowsocks-rust/config.json <<EOF
{
    "server":"0.0.0.0",
    "server_port":9000,
    "password":"password0",
    "timeout":300,
    "method":"aes-256-gcm",
    "nameserver":"8.8.8.8",
    "mode":"tcp_and_udp",
    "plugin":"xray-plugin",
    "plugin_opts":"server"
}
EOF

For more v2ray-plugin configrations please visit v2ray-plugin usage⁠.

For more xray-plugin configrations please visit xray-plugin usage⁠.

This container with sample configuration /etc/shadowsocks-rust/config.json

There is an example to start a container that listens on 9000 (both TCP and UDP):

$ docker run -d -p 9000:9000 -p 9000:9000/udp --name ss-rust --restart=always -v /etc/shadowsocks-rust:/etc/shadowsocks-rust teddysun/shadowsocks-rust

Warning: The port number must be same as configuration and opened in firewall.