From a7afc1cd8a0c45b7b9e71c744223232bbceec481 Mon Sep 17 00:00:00 2001 From: sd4v1d Date: Thu, 10 Feb 2022 10:47:12 +0100 Subject: [PATCH] Set production port to standard 433, and documentation update --- README.md | 26 ++++++++++++++++---------- app/README.md | 6 +++--- app/public/config/config.example.js | 2 +- server/README.md | 4 ++-- 4 files changed, 22 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index e37cb48a..0b13c4c7 100644 --- a/README.md +++ b/README.md @@ -67,7 +67,7 @@ See [more](https://github.com/edumeet/edumeet-ansible/). If you want to install it on the Debian & Ubuntu based operating systems. -* Prerequisites: [node v14.x](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) (tested with v14.18.3 version) +* Prerequisites: [node v16.x](https://github.com/nodesource/distributions/blob/master/README.md#debinstall) (tested with v16.13.2 version) * Get package [here](https://github.com/edumeet/edumeet/actions?query=workflow%3ADeployer+branch%3Amaster+is%3Asuccess) (job artifact) @@ -123,18 +123,18 @@ Note: Edumeet will start on the default settings (if you don't create your own c Important! You must always **rebuild** the edumeet when you change something in the configuration files. #### use template (example) -Just clone the example files and adjust them +Just clone the example files and adjust them if required. ```bash cp server/config/config.example.js server/config/config.js cp app/public/config/config.example.js app/public/config/config.js ``` -#### create your own config (yaml or json) +#### To change default options, create your own server config file (yaml or json) -Example when _config.yaml_: +Example when usingi _config.yaml_ file ```yaml -turnAPIKey: "" +turnAPIKey: "" turnAPIURI: "https://api.turn.geant.org/turn" mediasoup: webRtcTransport: @@ -142,12 +142,18 @@ mediasoup: - ip: "" announcedIp: "" ``` -Example when _config.js_ +Example when using _config.json_ file ```javascript -var config = { - developmentPort : 8443, - productionPort : 3443 + [ + { + "urls": [ + "turn:turn.example.com:443?transport=tcp" + ], + "username": "example", + "credential": "example" + } + ] }; ``` @@ -214,7 +220,7 @@ sudo systemctl enable edumeet ## Ports and firewall | Port | protocol | description | | ---- | ----------- | ----------- | -|3443 | tcp | default https webserver and signaling - adjustable in `server/config.js`) | +|443 | tcp | default https webserver and signaling - adjustable in `server/config.js`) | | 4443 | tcp | default `yarn start` port for developing with live browser reload, not needed in production environments - adjustable in app/package.json) | | 40000-49999 | udp, tcp | media ports - adjustable in `server/config.js` | diff --git a/app/README.md b/app/README.md index ba0d5449..d2ea88b2 100644 --- a/app/README.md +++ b/app/README.md @@ -3,12 +3,12 @@ The app configuration file should be a valid javascript file defining a single `config` object containing the properties that you need to modify. -Example `public/config/config.js`: +Example `public/config/config.example.js`: ```javascript var config = { developmentPort : 3443, - productionPort : 8443 + productionPort : 443 }; ``` The actual app-config of a running edumeet instance can you get on https://yourinstance:yourport/?config=true @@ -21,7 +21,7 @@ can be found here: [config.example.js](public/config/config.example.js). | :--- | :---------- | :----- | :------------ | | loginEnabled | If the login is enabled. | `"boolean"` | ``false`` | | developmentPort | The development server listening port. | `"port"` | ``3443`` | -| productionPort | The production server listening port. | `"port"` | ``8443`` | +| productionPort | The production server listening port. | `"port"` | ``443`` | | serverHostname | If the server component runs on a different host than the app you can specify the host name. | `"string"` | ``""`` | | supportedBrowsers | Supported browsers version in bowser satisfy format. | `"object"` | ``{ "windows": { "internet explorer": ">12", "microsoft edge": ">18" }, "microsoft edge": ">18", "safari": ">12", "firefox": ">=60", "chrome": ">=74", "chromium": ">=74", "opera": ">=62", "samsung internet for android": ">=11.1.1.52"}`` | | networkPriorities | Network priorities. | `"object"` | ``{ "audio": "high", "mainVideo": "high", "additionalVideos": "medium", "screenShare": "medium"}`` | diff --git a/app/public/config/config.example.js b/app/public/config/config.example.js index 8cfe7c86..6cd51625 100644 --- a/app/public/config/config.example.js +++ b/app/public/config/config.example.js @@ -16,7 +16,7 @@ var config = { developmentPort : 3443, // The production server listening port. - productionPort : 8443, + productionPort : 443, // If the server component runs on a different host than the app you can specify the host name. serverHostname : '', diff --git a/server/README.md b/server/README.md index 19c48556..4a46c282 100644 --- a/server/README.md +++ b/server/README.md @@ -15,7 +15,7 @@ redisOptions: host: redis port: 6379 -listeningPort: 3443 +listeningPort: 443 ``` Additionally, a `config/config.js` can be used to override specific properties @@ -43,7 +43,7 @@ Look at the default `config/config.example.js` file for documentation. | tls.cert | SSL certificate path. | `"string"` | ``"./certs/mediasoup-demo.localhost.cert.pem"`` | | tls.key | SSL key path. | `"string"` | ``"./certs/mediasoup-demo.localhost.key.pem"`` | | listeningHost | The listening Host or IP address. | `"string"` | ``"0.0.0.0"`` | -| listeningPort | The HTTPS listening port. | `"port"` | ``8443`` | +| listeningPort | The HTTPS listening port. | `"port"` | ``443`` | | listeningRedirectPort | The HTTP server listening port used for redirecting any HTTP request to HTTPS. If 0, the redirect server is disabled. | `"port"` | ``8080`` | | httpOnly | Listens only on HTTP on listeningPort; listeningRedirectPort disabled. Use case: load balancer backend. | `"boolean"` | ``false`` | | trustProxy | WebServer/Express trust proxy config for httpOnly mode. More infos: [expressjs](https://expressjs.com/en/guide/behind-proxies.html), [proxy-addr](https://www.npmjs.com/package/proxy-addr) | `"string"` | ``""`` |