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

Merge branch 'fabric' of https://github.com/J-onasJones/McWebserver into fabric

Browse source
This commit is contained in:
Jonas_Jones 2022-07-26 20:05:23 +02:00
commit 3a373a2da3
1 changed files with 10 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,16 +1,24 @@
# McWebserver
This is the fabric port, the Forge version is available [here](https://github.com/J-onasJones/McWebserver-forge)
## About the mod
### 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).
A Forge port is also on the way.
### 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.
### Setup
1. Head over to [modrinth](https://modrinth.com/mod/mcwebserver) and curseforge (once approved) for now available in this repository's [releases](https://github.com/J-onasJones/McWebserver/releases/latest) and download it into your mods folder.
1. Head over to [modrinth](https://modrinth.com/mod/mcwebserver) or [curseforge](https://www.curseforge.com/minecraft/mc-mods/mcwebserver) 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: