Skip to content

Commit

Permalink
Document usage with docker-compose
Browse files Browse the repository at this point in the history
  • Loading branch information
fu5ha authored and iSchluff committed Apr 11, 2022
1 parent 0e98847 commit 302d20d
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,30 @@ Start docker with custom config. See [config.toml.example](config.toml.example)
docker run -v $(pwd)/config.toml:/home/srtrelay/config.toml ghcr.io/voc/srtrelay/srtrelay:latest
```

## Run with docker-compose

In your `docker-compose.yml`:

```yaml
srtrelay:
image: ghcr.io/voc/srtrelay/srtrelay:latest
restart: always
container_name: srtrelay
volumes:
- ./srtrelay-config.toml:/home/srtrelay/config.toml
ports:
- "44560:1337/udp"
```
This will forward port `44560` to internal port `1337` in the container. Importantly, forwarding UDP is required.
It will also copy a `srtrelay-config.toml` file in the same directory into the container to use as config.toml

Start the server with the usual

```bash
docker-compose up -d
```

## Build with docker
You will need atleast docker-20.10

Expand Down

0 comments on commit 302d20d

Please sign in to comment.