Jonas_Jones/McWebserver
1
0
Fork 0
mirror of https://github.com/JonasunderscoreJones/McWebserver.git synced 2025-10-23 03:19:19 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
McWebserver/README.md
triphora f518d1572d
Fix Modrinth badges 
v1 of Modrinth's API has been deprecated since January 2022 and is scheduled to begin breaking in February, with a complete breakage being done by March. This pull request has been created as a courtesy to update it to use the dedicated shields.io badge rather than manually constructing the API request.

After merging this PR, please also update any usages on other pages, for example a CurseForge and/or Modrinth project description, and also cherry-pick/copy these changes to any other branches you might have.
2023-01-21 21:00:48 -05:00

3.1 KiB
Raw Blame History

McWebserver

This is the fabric port, the Forge version is available here

License Discord CF Modrinth GitHub all releases

About the mod

This mod runs a simple HTTP server alongside the minecraft server in seperate threads. The mod allows You to host websites, share files and Server Backups directly from your server without the need of a seperate server setup. Adjust the port and design your website.

The http server has up to no performance impact on the server on idle and only slightly affects it for a short amount of time (usually a couple milliseconds) when a user visits the website or requests a file.

Currently no ssl encryption is implemented yet and therefore HTTPS isn't possible, but it's coming soon(TM).

Warning

If used wrongly this mod can be a security risk for your server and all devices connected to the network that your server is in.

Do only put files into your webservers root directory that you want to be accessible to the internet. Those files are public to the entire world.

Use at your own risk!

Setup

  1. Head over to modrinth or curseforge and download the correct version of the mod into your mods folder.
  2. Restart Your Minecraft Server and let the mod create the config file. The webserver will be offline by default.
  3. In the config file, enable the webserver and adjust all settings if needed.
  4. Add the following files to your Webservers root directory:
    • index.html (the homepage)
    • 404.html (the website that shows up if a request is sent for a file that doesn't exist on the server)
    • not_supported.html (this is page is very unlikely to show up at any time and isn't necessary)
  5. Restart your Minecraft server and You're good to go!