Upstream
/
dynmap
mirror of https://github.com/webbukkit/dynmap.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Initial Installation Page Draft 1 - The Great Wiki Revamp of August 2020

FedUpWith-Tech 2020-08-15 09:20:00 -04:00
parent 27ad227e73
commit 14580582fb
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
Installation.md

@ -1 +1,32 @@
# This page is currently a placeholder for future content as a part of the great wiki revamp of August 2020, please stand by or contact @FedUpWithTech on the [Dynmap Discord](https://discord.gg/52pqBpw) to find out how to help out
# This page is currently under construction as a part of the great wiki revamp of August 2020, please standby or contact @FedUpWithTech on the [Dynmap Discord](https://discord.gg/52pqBpw) to find out how to help out
***
# Installation
### This page is a user-friendly and simple explanation of how to install Dynmap and make it accessible to your players. User generated video tutorials are [located at the bottom of the page](#Video-Tutorials)
**Prerequisites**
* This page assumes you are the server admin of a Minecraft server running a supported platform on a supported version. All versions and servers that are currently supported can be found in [[Features]]
* This page assumes you have adequate knowledge of the host OS or hosting solution you are using to install the plugin and port forward/request ports as necessary
* This page assumes you will download the latest version of Dynmap from an official source. Official sources can also be found in [[Features]]
## Getting Started
1. **Stop your Minecraft server**. You may be tempted to use `/reload` or later `/dynmap reload`... **DON'T** for many reasons the /reload commands break things and while they do exist they are not recommended. If you make a configuration change you'll need to need to restart your server, hopefully the `/discord reload` command will be more stable in the future.
2. **Download the dynmap plugin**. Common download locations are [CurseForge for modded](https://www.curseforge.com/minecraft/mc-mods/dynmapforge), [Spigot](https://www.spigotmc.org/resources/dynmap.274/), [Bukkit](https://dev.bukkit.org/projects/dynmap), or the [Github release page](https://github.com/webbukkit/dynmap/releases).
3. **Adding the Dynmap plugin**. Move the downloaded Dynmap-<version>.jar into your `server/plugins/` or `server/mods/` folder respectively
4. **Start your server**
5. **Verifying installation**. A new folder will have been created in the plugins or mods folder `/dynmap/` in this folder a file `configuration.txt` will be created. This file contains just about everything you need to configure all aspects of the plugins but it can be incredibly overwhelming and is a large document that most users won't even change all but one or two lines. For full documentation on this file or for something to read to put you to sleep visit [[Configuration.txt]]
6. **Port forwarding**. This is the step where most users or first time server admins get caught up, I'll break this section into several subsections based on server type for clarity.
1. **Server Hosts** Most server hosts only allow one port by default (for your minecraft server) but allow users to "request" other ports to be opened. Most commonly this is done by through their ticketing system but you will have to find out how to request ports for your specific server host. If they give you an option, port 8123 is the default that dynmap uses but you likely will be assigned a random port. For example say your server host give you port 7229 to use. Modify line 322 of configuration.txt from
`webserver-port: 8123`
to
`webserver-port: 7229`
Be sure to restart your server after you make this change then, in your web browser, go to `http://\<server-ip>:7229/` for example if the IP you type in minecraft is `192.192.192.192:25565` then the address you type in the web browser would be `http://192.192.192.192:7229/` Now that we have Dynmap up and running, you can move to the next section.
2. **VPS** As there are more VPS's providers and more "standards" than I can count with both my hands and feet I can't give specific tutorials like with dedicated Minecraft server hosts the general information still applies. If you are on a shared IP, request a new port from your provider. If you are on a dedicated IP, forward port 8123 then go to your favorite chromium fork and enter `http://\<server-ip>:8123` If you are given another port to use in a shared VPS then change the port in the config as described above and enter that address in your browser. Move on to the next step when you can access Dynmap from the web browser.
3. **Self-Hosted** Since your server is self-hosted you likely are on a dedicated IP. If you are not on a dedicated IP, how did you get Minecraft set up? Hopefully you still remember how to port forward from when you port forwarded for your Minecraft server. If not, [this website](https://portforward.com/) is a fantastic resource as a refresher. Once you've opened a port make sure you can connect to the Dynmap website by going to `http://\<server-ip>:8123` just to be clear, if your server you type into Minecraft is `192.192.192.192:25565` the ip you would type is `http://192.192.192.192:8123/` If you can connect to you your Dynmap web map move on to the next step.
4. **Issues?** Don't worry, you aren't the first to have issues getting past this step nor will you be the last. Networking is super confusing and I have my degree in networking. First, lets check your server log and make sure dynmap started correctly. You should see a line in the startup log like this
`[dynmap] Web server started on address 0.0.0.0:8123`
If there is an error here your port is likely in use already or there is a firewall issue on your OS. These issues are a bit too specific to cover in a guide so please contact the Dynmap team for support. However, if Dynmap did start correctly and there are no other related errors in the log then there was likely an issue with port forwarding or a firewall somewhere. First go to [canyouseeme.org](https://www.canyouseeme.org/) and enter your ip address and your port. It will check if the port is open, if it isn't then the issue lies in a firewall or your router. More information about port forwarding, how to do it, what it means, and what are the risks visit [this site.](https://portforward.com/) For all other issues or if you are still unable to open a port then contact the Dynmap team for support.
## Configuring Dynmap
## Video Tutorials