diff --git a/README.md b/README.md index e185e2a..fdd3b40 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # shadowsocks-rust-docker + Docker deployment solution of [shadowsocks-rust](https://github.com/shadowsocks/shadowsocks-rust) # Usage @@ -6,11 +7,17 @@ Docker deployment solution of [shadowsocks-rust](https://github.com/shadowsocks/ ```bash git clone https://github.com/CaKrome/shadowsocks-rust-docker.git +# Create a .env file +cp .env.sample .env + +# Create a config.json file +cp config.json.sample config.json + +# Now edit the .env file and config.json to the configuation you like. Note that both files must use the sample port. + # Build the docker image docker compose build -# Now edit the file config.json to the configuation you like and also port in docker-compose.yml if you changed the default port. - # Bring the service up docker compose up -d ```