shadowsocks_install/docker/shadowsocks-libev/README.md
Teddysun c00c849326
Update README.md
Signed-off-by: Teddysun <i@teddysun.com>
2018-08-11 17:24:17 +09:00

84 lines
2.3 KiB
Markdown

## Shadowsocks-libev Docker Image by Teddysun
[shadowsocks-libev][1] is a lightweight secured socks5 proxy for embedded devices and low end boxes.
It is a port of [shadowsocks][2] created by @clowwindy maintained by @madeye and @linusyang.
Docker images are built for quick deployment in various computing cloud providers.
For more information on docker and containerization technologies, refer to [official document][3].
## Prepare the host
If you need to install docker by yourself, follow the [official installation guide][4].
## Pull the image
```bash
$ docker pull teddysun/shadowsocks-libev
```
or pull image based **alpine**
```bash
$ docker pull teddysun/shadowsocks-libev:alpine
```
This pulls the latest release of shadowsocks-libev.
It can be found at [Docker Hub][5].
## Start a container
You **must create a configuration file** `/etc/shadowsocks-libev/config.json` in host at first, and sample:
```
{
"server":"0.0.0.0",
"server_port":9000,
"password":"password0",
"timeout":300,
"method":"aes-256-gcm",
"fast_open":true,
"nameserver":"8.8.8.8",
"mode":"tcp_and_udp"
}
```
and if you want to enable **simple-obfs**, configuration file `/etc/shadowsocks-libev/config.json` sample:
```
{
"server":"0.0.0.0",
"server_port":9000,
"password":"password0",
"timeout":300,
"method":"aes-256-gcm",
"fast_open":true,
"nameserver":"8.8.8.8",
"mode":"tcp_and_udp",
"plugin":"obfs-server",
"plugin_opts":"obfs=tls"
}
```
This container with sample configuration `/etc/shadowsocks-libev/config.json`
There is an example to start a container that listens on `9000` (both TCP and UDP):
```bash
$ docker run -d -p 9000:9000 -p 9000:9000/udp --name ss-libev -v /etc/shadowsocks-libev:/etc/shadowsocks-libev teddysun/shadowsocks-libev
```
There is an example to start a container based **alpine** that listens on `9000` (both TCP and UDP):
```bash
$ docker run -d -p 9000:9000 -p 9000:9000/udp --name ss-libev -v /etc/shadowsocks-libev:/etc/shadowsocks-libev teddysun/shadowsocks-libev:alpine
```
**Note**: The port number must be same as configuration.
[1]: https://github.com/shadowsocks/shadowsocks-libev
[2]: https://shadowsocks.org/en/index.html
[3]: https://docs.docker.com/
[4]: https://docs.docker.com/install/
[5]: https://hub.docker.com/r/teddysun/shadowsocks-libev/