Browse Source

docs: add README.md

pull/2/head
dnomd343 3 years ago
parent
commit
d8ba9aebc2
  1. 26
      README.md

26
README.md

@ -0,0 +1,26 @@
## Quick Start
Start a syncplay service, default at port tcp/8999.
```bash
docker run -d \
--net=host \
--name=syncplay \
-e PORT=<PORT> \
-e PASSWORD=<PASSWORD> \
dnomd343/syncplay
```
If TLS is enabled, you have to set hostname and certificate folder
```bash
docker run -d \
--net=host \
--name=syncplay \
--hostname=syncplay.your.domain
-e PORT=<PORT> \
-e PASSWORD=<PASSWORD> \
-e TLS=/certs \
-v <certs>:/certs \
dnomd343/syncplay
```
Loading…
Cancel
Save