diff --git a/README.md b/README.md new file mode 100644 index 0000000..2818450 --- /dev/null +++ b/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= \ +-e 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= \ +-e PASSWORD= \ +-e TLS=/certs \ +-v :/certs \ +dnomd343/syncplay +```