From cce47395883e9946fc89092f55cb5ba116c4dd78 Mon Sep 17 00:00:00 2001 From: James Lyne Date: Wed, 19 May 2021 19:02:41 +0100 Subject: [PATCH] Updated Configuring Multiple Servers (markdown) --- Configuring-Multiple-Servers.md | 82 ++++++++++++++++++++++++++++++++- 1 file changed, 81 insertions(+), 1 deletion(-) diff --git a/Configuring-Multiple-Servers.md b/Configuring-Multiple-Servers.md index 30404ce..6a05ece 100644 --- a/Configuring-Multiple-Servers.md +++ b/Configuring-Multiple-Servers.md @@ -1 +1,81 @@ -TODO \ No newline at end of file +As of 1.0.0, LiveAtlas now supports multiple servers within one instance. This feature is designed to remove the need for maintaining multiple copies of LiveAtlas if you have multiple servers with maps. Configuring multiple servers will add a section within the map dropdown allowing the user to switch between them. + +![Multiple servers example](https://minecraft.rtgame.co.uk/liveatlas/servers.jpg) + +## How it works +When multi-server support is enabled in LiveAtlas, the URL will be appended with the server the user is currently viewing. For example, if LiveAtlas is hosted at `https://example.com/map/` and the user is on the `survival` server, the URL will `https://example.com/map/survival`. + +This subdirectory-based approach was chosen for its relative simplicity and because it allows for any old URLs to be redirected without losing information. Adding the server name to the URL hash was another option, but as hashes are not sent to the server redirects would lose any locations present in the initial URL. Fully configurable URLs would also add additional challenges when working within the limitations of the same origin policy and ensuring the relative asset URLs in index.html resolved correctly. + +## Requirements +- External webserver + + Multiple server support currently **requires** LiveAtlas be hosted on an external webserver. The internal dynmap server will not work for this as it will not route the server URLs correctly. + +- Appropriately configured CORS headers + + LiveAtlas needs to be able to make requests to each configured server. If your servers are accessed via a [different origin](https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy#definition_of_an_origin) to LiveAtlas itself, then you will need to ensure [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) are configured correctly. Headers for the internal server can be configured using dynmap's [http-response-headers setting](https://github.com/webbukkit/dynmap/wiki/Configuration.txt#http-response-headers) + +## Setup +1. Setup LiveAtlas at the URLs you want to use + + LiveAtlas needs to be accessible via the URLs of all servers you wish to use. For example if you want your server maps to be accessible via `https://example.com/map/` with servers named `creative` and `survival`, you will need to ensure LiveAtlas is accessible via `https://example.com/map/survival` and `https://example.com/map/creative`. + + A simple way to do this is to host LiveAtlas at `https://example.com/map/` (note the trailing `/`) and configure your webserver to route requests for nonexistant files to LiveAtlas' index.html. The below example for nginx routes requests to non-existant files for `/map/` URLs to LiveAtlas: + + location ~ ^/map/ { + index index.html; + try_files $uri /map/index.html; + + # If you're hosting dynmap's php files in the same folder + location ~ \.php$ { + fastcgi_split_path_info ^(.+\.php)(/.+)$; + fastcgi_pass unix:/run/php/php7.4-fpm.sock; + fastcgi_index index.php; + include /etc/nginx/fastcgi_params; + fastcgi_param SCRIPT_FILENAME $request_filename; + } + } + +2. Configure LiveAtlas for multiple servers + + Multiple server support is configured in index.html. Look for the `