From 00021c03dc6f5d80d4f34c6b369522d10286b4eb Mon Sep 17 00:00:00 2001 From: Nick Krecklow Date: Tue, 5 May 2020 17:39:51 -0500 Subject: [PATCH] add wss behavior note to README.md and docs/CHANGELOG.md --- README.md | 2 ++ docs/CHANGELOG.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/README.md b/README.md index ad1138a..394a1a2 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,8 @@ You can see an up-to-date copy of the production branch running on https://minet 5. Run ```npm run build``` (this bundles `assets/` into `dist/`) 6. Run ```node main.js``` to boot the system (may need sudo!) +If your deployment is using **https**, you will need to modify line 13 in `assets/js/socket.js` to use `wss://` instead of `ws://`. Otherwise browsers may prevent the WebSocket connection as it would be insecure on a secured connection. + (There's also ```install.sh``` and ```start.sh```, but they may not work for your OS.) Database logging is disabled by default. You can enable it in ```config.json``` by setting ```logToDatabase``` to true. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 08be340..63614b7 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -3,6 +3,8 @@ - Frontend reconnect behavior has been improved to use exponential backoff behavior (up to 30 seconds) with unlimited retries. - The "Lost connection!" message will now show the reconnection attempt timer. +If your deployment is using **https**, you will need to modify line 13 in `assets/js/socket.js` to use `wss://` instead of `ws://`. Otherwise browsers may prevent the WebSocket connection as it would be insecure on a secured connection. + **5.2.1** *(May 1 2020)* - The historical graph will now auto scale its yaxis steps.