Skirda/LiveAtlas
4
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Created Installation (markdown)

James Lyne 2021-09-07 19:33:35 +01:00
parent ebb633b5f6
commit 33f8030cb5
1 changed files with 49 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
Installation.md Normal file

@ -0,0 +1,49 @@
The installation process for LiveAtlas varies depending on where you choose to install it.
LiveAtlas will function as a drop-in replacement on the Dynmap internal webserver, and with a little extra configuration on the Pl3xmap internal webserver. However 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.
## Dynmap internal webserver installation
LiveAtlas is a drop-in replacement for the default Dynmap UI and should work without additional configuration.
1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
2. Extract into the `plugins/dynmap/web` folder on your Minecraft server. The existing index.html should be overwritten.
3. (Recommended) Set index.html as read-only. This will prevent Dynmap overwriting it after every update.
4. Clear any CDN caches you may have. If you don't know what this means then don't worry about it.
5. Done.
## Pl3xmap internal webserver installation
LiveAtlas by default expects a local Dynmap installation, and requires some extra configuration to work with the Pl3xmap internal webserver.
1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
2. Extract into the `plugins/Pl3xMap/web` folder on your Minecraft server. The existing index.html should be overwritten.
3. Open Pl3xmap's config.yml and set `auto-update` to `false`. This will prevent Pl3xmap overwriting LiveAtlas files.
4. Update `window.liveAtlasConfig` in index.html.
Update the `servers` config to the below:
servers: {
pl3xmap: {
pl3xmap: window.location.pathname
}
},
This will configure LiveAtlas to expect a local Pl3xmap installation.
5. Remove the `standalone/config.js` `<script>` tag from index.html
This file is not required for Pl3xmap, and removing this `<script>` will avoid an unnecessary extra request.
6. Clear any CDN caches you may have. If you don't know what this means then don't worry about it.
7. Done.
## External webserver installation
LiveAtlas is a drop-in replacement for an existing Dynmap installation on an external webserver. Pl3xmap and multiple server support require additional configuration.
1. [Download the latest release](https://github.com/JLyne/LiveAtlas/releases/latest)
2. Extract into your webserver root. Any existing index.html should be overwritten.
3. Configure as required
* For a single dynmap installation no additional configuration should be required
* For a single Pl3xmap installation, follow step 4 of the [internal webserver installation]()
* For multiple servers, see [this page]()
4. Clear any CDN caches you may have. If you don't know what this means then don't worry about it.
5. Done