The WebServer plugin allows your Minecraft server to become a website very easily. Built on the same technology Dynmap is powered by, this plugin brings a Jetty HTTP server right into your Bukkit one. What does that actually mean? It means that your server is now a fully customizable website. You can create and modify HTML files accessible from any browser in the world!
How do I access my new website?
For starters, the website will use your server's IP address. However, that's not the only thing you'll be putting into your browser. To connect to any IP you have to travel through a port. You specify that port immediately after the IP, so if I wanted to connect to the IP 127.0.0.1 (a.k.a. localhost) and I wanted to connect over port 21, the complete address would be 127.0.0.1:21. If I did not include the :21, a default value would be use. This varies depending on the service you use. Minecraft servers by default use port 25565. HTTP uses port 80 by default. For some security reason you can't open port 80 with this plugin, so you'll have to choose another one (obviously not what your MC server is running on). So to connect you would put IP:port in your browser. Make sure you port forward the port you're using, too!
What file does my website point to?
The first thing you need to know is that every file I mention here will be auto generated if they're not present. The folder your website points to is called the resource base. By default, it's in ./plugins/WebServer/web/. The period before it is important because without it the resource base would point to C:/plugins/WebServer/web/. When your first access your website, it will redirect you to the index file, which is by default called index.html and is in the resource base, so it's in ./plugins/WebServer/web/index.html. If the user tries to access a page that isn't there, a 404.png will appear instead. You can change the default png by putting a different one in the resource base, by default ./plugins/WebServer/web/404.png.
How do I configure it?
Upon first use, a config file will be generated at /plugins/WebServer/config.yml. In it, you can change what port the web server operates on, where the resource base is, and what the default index file is. The default configuration file is shown below:
port: 8080
resource base: ./plugins/WebServer/web/
index: index.html
This is a changed file that someone might use:
port: 25566
resource base: ./my website/
index: index.txt
It is
very important that you include a period before the resource base because that means the actual resource base is in the current directly (wherever the server jar is) plus where you specified it. You can take away the period in order to make the resource base in a different place, like in a folder on your desktop or someplace else.
If you have any additional questions, feel free to comment, PM me, or email me at jsncoding@gmail.com.
