diff --git a/docs/install.md b/docs/install.md index 05a5ae2f..b2480985 100644 --- a/docs/install.md +++ b/docs/install.md @@ -14,21 +14,24 @@ Setting up Screego with docker is pretty easy, you basically just have to start The [screego/server](https://hub.docker.com/r/screego/server) docker images are multi-arch docker images. This means the image will work for `amd64`, `i386`, `ppc64le` (power pc), `arm64`, `arm v7` (Raspberry PI). -?> When using [TURN](nat-traversal.md), - Screego will allocate random ports for relay connections. Thus, network host is needed. +When using [TURN](nat-traversal.md), Screego will allocate ports for relay connections. -```bash -$ docker run --net=host -e SCREEGO_EXTERNAL_IP=YOUREXTERNALIP screego/server:GITHUB_VERSION -``` +The ports must be mapped that the host system forwards them to the screego container. + +By default, Screego runs on port 5050. + +?> Replace `YOUREXTERNALIP` with your external IP. One way to find your external ip is with ipify. + ```bash + $ curl 'https://api.ipify.org' + ``` + +### Network Host (recommended) -Replace `YOUREXTERNALIP` with your external IP. One way to find your external ip is with ipify. ```bash -$ curl 'https://api.ipify.org' +$ docker run --net=host -e SCREEGO_EXTERNAL_IP=YOUREXTERNALIP screego/server:GITHUB_VERSION ``` -By default, Screego runs on port 5050. - -### docker-compose.yml +#### docker-compose.yml ```yaml version: "3.7" @@ -40,9 +43,38 @@ services: SCREEGO_EXTERNAL_IP: "YOUREXTERNALIP" ``` -Replace `YOUREXTERNALIP` with your external IP. One way to find your external ip is with ipify. +### Port Range + +`SCREEGO_TURN_STRICT_AUTH` should only be disabled if you enable TLS inside +Screego and not use a reverse proxy with `SCREEGO_TRUST_PROXY_HEADERS=true`. + + ```bash -$ curl 'https://api.ipify.org' +$ docker run \ + -e SCREEGO_TURN_PORT_RANGE=50000:50100 \ + -e SCREEGO_TURN_STRICT_AUTH=false \ + -e SCREEGO_EXTERNAL_IP=YOUREXTERNALIP \ + -p 5050:5050 \ + -p 3478:3478 \ + -p 50000-50100:50000-50100/udp \ + screego/server:GITHUB_VERSION +``` + +#### docker-compose.yml + +```yaml +version: "3.7" +services: + screego: + image: screego/server:GITHUB_VERSION + ports: + - 5050:5050 + - 3478:3478 + - 50000-50100:50000-50100/udp + environment: + SCREEGO_TURN_PORT_RANGE: "50000:50100" + SCREEGO_EXTERNAL_IP: "YOUREXTERNALIP" + SCREEGO_TURN_STRICT_AUTH: "false" ``` ## Binary