From 742384cf9cac57755174bda613c526ecf1dacf9c Mon Sep 17 00:00:00 2001 From: dnomd343 Date: Sun, 26 Jun 2022 23:11:27 +0800 Subject: [PATCH] docs: update README.md --- README.md | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 92d9ccb..8406ab8 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,26 @@ ## Quick Start -Start a syncplay service, default at `tcp/8999`, you can also specify a password. +Start a syncplay service at `tcp/8999`, you can also specify a password. ```bash docker run -d \ ---net=host \ ---name=syncplay \ --e PORT= \ --e PASSWORD= \ +--network host \ +--name syncplay \ +--env PORT= \ +--env PASSWORD= \ dnomd343/syncplay ``` -If TLS is enabled, you have to set hostname and certificate folder. +If TLS is enabled, you have to set certificate folder with `privkey.pem`, `cert.pem` and `chain.pem`. ```bash docker run -d \ ---net=host \ ---name=syncplay \ ---hostname=syncplay.your.domain --e PORT= \ --e PASSWORD= \ --e TLS=/certs \ --v :/certs \ +--network host \ +--name syncplay \ +--env PORT= \ +--env PASSWORD= \ +--env TLS=/certs \ +--volume :/certs \ dnomd343/syncplay ```