Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CaKrome committed Jun 3, 2024
1 parent 4c6b84c commit 20446df
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,23 @@
# shadowsocks-rust-docker

Docker deployment solution of [shadowsocks-rust](https://github.com/shadowsocks/shadowsocks-rust)

# Usage

```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
```

0 comments on commit 20446df

Please sign in to comment.