Updated Installation (markdown)

James Lyne 2022-02-28 14:21:43 +00:00
parent 61fbe0ece1
commit 0f960a0794

@ -1,8 +1,8 @@
The installation process for LiveAtlas varies depending on where you choose to install it. The installation process for LiveAtlas varies depending on where you choose to install it.
LiveAtlas will function as a drop-in replacement for a single Dynmap installation on an internal or external webserver, and with a little extra configuration for a Squaremap or Pl3xmap installation. Using an external webserver is highly recommended as it offers the most flexibility and compatibility. LiveAtlas will function as a drop-in replacement for a single Dynmap installation on an internal or external webserver, and with a little extra configuration for a Squaremap, Pl3xmap or Overviewer installation. Using an external webserver is highly recommended as it offers the most flexibility and compatibility.
If you don't know which guide to follow, you probably want the internal webserver guide for your chosen map plugin. If you don't know which guide to follow, you probably want the internal webserver guide for your chosen map plugin. Overviewer has no internal webserver, so follow the external webserver guide for that.
## Dynmap internal webserver installation ## Dynmap internal webserver installation
LiveAtlas is a drop-in replacement for the default Dynmap UI and should work without additional configuration. LiveAtlas is a drop-in replacement for the default Dynmap UI and should work without additional configuration.
@ -57,9 +57,9 @@ LiveAtlas by default expects a Dynmap installation, and requires some extra conf
7. Done. 7. Done.
## External webserver installation ## External webserver installation
LiveAtlas is a drop-in replacement for an existing Dynmap installation on an external webserver. Squaremap, Pl3xmap and multiple server support require additional configuration. LiveAtlas is a drop-in replacement for an existing Dynmap installation on an external webserver. Squaremap, Pl3xmap, Overviewer and multiple server support require additional configuration.
1. Follow the [Dynmap](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) or [Pl3xmap](https://github.com/pl3xgaming/Pl3xMap/wiki/Internal-vs-External-Web-Server#external-server) guides for setting up an external server if required 1. Follow the [Dynmap](https://github.com/webbukkit/dynmap/wiki/External-Webserver-Basics) or [Pl3xmap](https://github.com/pl3xgaming/Pl3xMap/wiki/Internal-vs-External-Web-Server#external-server) guides for setting up an external server if required.
2. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest) 2. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
3. Extract into your webserver root. 3. Extract into your webserver root.
@ -67,8 +67,15 @@ LiveAtlas is a drop-in replacement for an existing Dynmap installation on an ext
4. Configure as required 4. Configure as required
* For a single dynmap installation no additional configuration should be required * For a single Dynmap installation no additional configuration should be required
* For a single Squareap or Pl3xmap installation, continue from step 4 of the [Squaremap/Pl3xmap internal webserver installation](https://github.com/JLyne/LiveAtlas/wiki/Installation#squaremappl3xmap-internal-webserver-installation) * For a single Squaremap or Pl3xmap installation, continue from step 4 of the [Squaremap/Pl3xmap internal webserver installation](https://github.com/JLyne/LiveAtlas/wiki/Installation#squaremappl3xmap-internal-webserver-installation)
* For a single Overviewer installation, add the following to `window.liveAtlasConfig` in index.html:
servers: {
overviewer: {
overviewer: window.location.pathname
}
},
* For configuring multiple servers, see [this page](https://github.com/JLyne/LiveAtlas/wiki/Configuring-Multiple-Servers) * For configuring multiple servers, see [this page](https://github.com/JLyne/LiveAtlas/wiki/Configuring-Multiple-Servers)
5. Clear any CDN caches you may have. 5. Clear any CDN caches you may have.