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 20446df commit 7adf5ef
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,34 @@ Docker deployment solution of [shadowsocks-rust](https://github.com/shadowsocks/

# Usage

## Clone the repo

```bash
git clone https://github.com/CaKrome/shadowsocks-rust-docker.git
```

# Create a .env file
## Create a .env file

```bash
cp .env.sample .env
```

## Create a config.json file

# Create a config.json file
```bash
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 same port.

# 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

# Build the docker image
```bash
docker compose build
```

## Bring shadowsocks-rust up

# Bring the service up
```bash
docker compose up -d
```

0 comments on commit 7adf5ef

Please sign in to comment.