Fascinated/Minetrack
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

add wss behavior note to docs/MIGRATING.md

Browse Source
This commit is contained in:
Nick Krecklow 2020-05-05 17:46:35 -05:00
parent 00021c03dc
commit 899c094cb1
No known key found for this signature in database
GPG Key ID: 5F149FDE156FFA94
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/MIGRATING.md
View File

@ -8,12 +8,13 @@ Minetrack 5 is the first of several upcoming updates designed to address several
4. Open the directory and execute `npm install --build-from-source`. This will install updated (and new) dependencies needed by the program.
5. If you have `logToDatabase: true` in your `config.json`, make sure to copy your `database.sql` file into the new directory, otherwise you will lose historical server activity and records.
6. Copy your existing `config.json` and `servers.json` files into the new directory.
7. Build your copy of `dist/`.
8. If you have previously configured any `faviconOverride` values within `config.json`, you will need to move them to the updated structure. Create a new directory within your Minetrack folder named `favicons/`.
9. If you have previously configured any `minecraft.json` values not included in the new `minecraft_versions.json` file, you will need to update their structure copy them to the new file.
10. Move your custom favicon images into the directory.
11. Open `servers.json` in your favorite editor.
12. For any server which you have a custom favicon, set the "favicon" field like so:
7. 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.
8. Build your copy of `dist/`.
9. If you have previously configured any `faviconOverride` values within `config.json`, you will need to move them to the updated structure. Create a new directory within your Minetrack folder named `favicons/`.
10. If you have previously configured any `minecraft.json` values not included in the new `minecraft_versions.json` file, you will need to update their structure copy them to the new file.
11. Move your custom favicon images into the directory.
12. Open `servers.json` in your favorite editor.
13. For any server which you have a custom favicon, set the "favicon" field like so:
```
{