Browse Source

Update documents regarding dockerization

* Update README.md in docker/alpine
  - Replace contents with the usage of the image auto-built by Docker Cloud
  - Add descriptions on the customizable environment variables
* Update Dockerfile maintainer list

Refer to #1914
pull/1920/head
Sah 6 years ago
parent
commit
2a250d2e0a
2 changed files with 56 additions and 20 deletions
  1. 2
      docker/alpine/Dockerfile
  2. 74
      docker/alpine/README.md

2
docker/alpine/Dockerfile

@ -3,7 +3,7 @@
# #
FROM alpine FROM alpine
MAINTAINER kev <noreply@datageek.info>
LABEL maintainer="kev <noreply@datageek.info>, Sah <contact@leesah.name>"
ENV SERVER_ADDR 0.0.0.0 ENV SERVER_ADDR 0.0.0.0
ENV PASSWORD= ENV PASSWORD=

74
docker/alpine/README.md

@ -1,38 +1,72 @@
shadowsocks-libev
=================
# Shadowsocks-libev Docker Image
[shadowsocks-libev][1] is a lightweight secured socks5 proxy for embedded [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 devices and low end boxes. It is a port of [shadowsocks][2] created by
@clowwindy maintained by @madeye and @linusyang. @clowwindy maintained by @madeye and @linusyang.
Suppose we have a VPS running Debian or Ubuntu.
To deploy the service quickly, we can use [docker][3].
Docker images are built for quick deployment in various computing cloud providers. For more information on docker and containerization technologies, refer to [official document][9].
## Install docker
## Prepare the host
Many cloud providers offer docker-ready environments, for instance the [CoreOS Droplet in DigitalOcean][10] or the [Container-Optimized OS in Google Cloud][11].
If you need to install docker yourself, follow the [official installation guide][12].
## Pull the image
```bash
$ docker pull shadowsocks/shadowsocks-libev
``` ```
$ curl -sSL https://get.docker.com/ | sh
$ docker --version
This pulls the latest release of shadowsocks-libev.
You can also choose to pull a previous release or to try the bleeding edge build:
```bash
$ docker pull shadowsocks/shadowsocks-libev:<tag>
$ docker pull shadowsocks/shadowsocks-libev:edge
``` ```
> A list of supported tags can be found at [Docker Hub][13].
## Build docker image
## Start a container
```bash ```bash
$ curl -sSL https://github.com/shadowsocks/shadowsocks-libev/raw/master/docker/alpine/Dockerfile | docker build -t shadowsocks-libev -
$ docker images
$ docker run -p8388:8388 -p8388:8388/udp -d --restart always shadowsocks/shadowsocks-libev:latest
```
This starts a container of the latest release with all the default settings, which is equivalent to
```bash
$ ss-server -s 0.0.0.0 -p 8388 -k "$(hostname)" -m aes-256-cfb -t 300 --fast-open -d 8.8.8.8 -d 8.8.4.4 -u
``` ```
> **Note**: It's the hostname in the container that is used as the password, not that of the host.
> You can also use a pre-built docker image: [vimagick/shadowsocks-libev][4] ![][5].
### With custom port
## Run docker container
In most cases you'll want to change a thing or two, for instance the port which the server listens on. This is done by changing the `-p` arguments.
Here's an example to start a container that listens on `28388` (both TCP and UDP):
```bash ```bash
$ docker run -d -e METHOD=aes-256-cfb -e PASSWORD=9MLSpPmNt -p 8388:8388 --restart always shadowsocks-libev
$ docker ps
$ docker run -p28388:8388 -p28388:8388/udp -d --restart always shadowsocks/shadowsocks-libev
``` ```
### With custom password
Another thing you may want to change is the password. To change that, you can pass your own password as an environment variable when starting the container.
Here's an example to start a container with `9MLSpPmNt` as the password:
```bash
$ docker run -e PASSWORD=9MLSpPmNt -p8388:8388 -p8388:8388/udp -d --restart always shadowsocks/shadowsocks-libev
```
> :warning: Click [here][6] to generate a strong password to protect your server. > :warning: Click [here][6] to generate a strong password to protect your server.
> You can use `ARGS` environment variable to pass additional arguments
### With other customizations
Besides `PASSWORD`, the image also defines the following environment variables that you can customize:
* `SERVER_ADDR`: the IP/domain to bind to, defaults to `0.0.0.0`
* `METHOD`: encryption method to use, defaults to `aes-256-cfb`
* `TIMEOUT`: defaults to `300`
* `DNS_ADDR`, `DNS_ADDR_2`: DNS servers to redirect NS lookup requests to, defaults to `8.8.8.8` and `8.8.4.4`
Additional arguments supported by `ss-server` can be passed with the environment variable `ARGS`, for instance to start in verbose mode:
```bash
$ docker run -e ARGS=-v -p8388:8388 -p8388:8388/udp -d --restart always shadowsocks/shadowsocks-libev:latest
```
## Use docker-compose to manage (optional) ## Use docker-compose to manage (optional)
@ -43,7 +77,7 @@ This is a sample `docker-compose.yml` file.
```yaml ```yaml
shadowsocks: shadowsocks:
image: shadowsocks-libev
image: shadowsocks/shadowsocks-libev
ports: ports:
- "8388:8388" - "8388:8388"
environment: environment:
@ -81,9 +115,11 @@ Don't forget to share internet with your friends.
[1]: https://github.com/shadowsocks/shadowsocks-libev [1]: https://github.com/shadowsocks/shadowsocks-libev
[2]: https://shadowsocks.org/en/index.html [2]: https://shadowsocks.org/en/index.html
[3]: https://github.com/docker/docker
[4]: https://hub.docker.com/r/vimagick/shadowsocks-libev/
[5]: https://badge.imagelayers.io/vimagick/shadowsocks-libev:latest.svg
[6]: https://duckduckgo.com/?q=password+12&t=ffsb&ia=answer [6]: https://duckduckgo.com/?q=password+12&t=ffsb&ia=answer
[7]: https://github.com/docker/compose [7]: https://github.com/docker/compose
[8]: https://shadowsocks.org/en/download/clients.html [8]: https://shadowsocks.org/en/download/clients.html
[9]: https://docs.docker.com/
[10]: https://www.digitalocean.com/products/linux-distribution/coreos/
[11]: https://cloud.google.com/container-optimized-os/
[12]: https://docs.docker.com/install/
[13]: https://hub.docker.com/r/shadowsocks/shadowsocks-libev/tags/
Loading…
Cancel
Save