heads up
Windows old PHP support will be removed soon! If you encounter any errors, please report them on
GitHub
introduction
Transform your Minecraft server with WebServer, a user-friendly and efficient plugin. By installing it and allocating an additional port(s) to your server, you gain an integrated web server accessible through your server's IP and port.
Configuration:
The default config includes settings for HTML and PHP ports, server IP, debugging, and more. Customize the ports to fit your preferences.
Code (Text):
Settings:
HTMLPORT: 25567
PHPPort: 25568
LocalFPM: 25569
LocalFPMComment: It's very important you have a FPM port if you decide to use php.
ServerLocation: /home/container/
ServerLocationComment: For most users on linux that are in a docker container don't change this. tho if you are NOT on a container please put the path to the server folder.
IndexLocation: ""
IndexComment: the default path is /webplugin/php/ so "" (yes blank) is in root folder of php. if yours is located in another place do "/path/to/index/folder"
ServerIP: localhost
ServerIPComment: Used for both PHP and HTML in the command /webp (only spigot/bukkit and such NOT Proxy) WebPlugin binds webservers to the 0.0.0.0 (servers ip)
debug: false
debugcomment: Only enable if I need debug logs or if you can figure out debug info yourself. This will NOT make a debug.log file it will post in console.
EnablePHP: false
PHPComment: If you use linux a fair warning here! WebPlugin WILL download a file from its distro on github (see bellow) this file is a precompiled version of php 8.2 and nginx 1.27.1 for linux. If you don't agree with this download please don't enable!
GithubWebPluginPHPRepo: https://github.com/hypersmc/WebPluginV2Repo
GithubWebPluginPHPRepoFilename: WebPlugin-linux-PHP8.2-PRECOMPILED.tar.gz
GithubWebPluginNGINXRepoFilename: WebPlugin-linux-NGINX-1.27.1-PRECOMPILED.tar.gz
GithubWebPluginComment: If this file name doesn't match the one downloaded then I either forgot to update this or something happened on the repo. Report it to me on discord :)
EnableHTML: true
HTMLComment: If you have PHP enabled you don't need html enabled as PHP can also handle HTML code.
Autokey: false
AutoKeyComment: Don't enable as it's still WIP.
SSLSettings: #PEM Key required!
EnableSSL: false
SSLPort: 25570
SSLDomain: domain.com
SSLPriv: private-key.pem
SSLPubl: public-key.pem
Linuxphpsettings:
Errorfolder: /errors/
#DO NOT IN ANY WAY EDIT THIS
ConfigVersion: 12
Note: Change the port from 25567 to your desired value.
SSL Configuration:
SSL support is available with options to enable, specify ports, and set up a LetsEncrypt (PEM) file.
Code (Text):
SSLSettings:
EnableSSL: false
SSLPort: 25570
SSLDomain: domain.com
SSLPriv: private-key.pem
SSLPubl: public-key.pem
Linux PHP Settings:
Code (Text):
Linuxphpsettings:
Errorfolder: /errors/
Discord Support:
Join our
Discord Server for support and community interactions.
Commands:
- /WebP: Displays server IP and port.
- /WebP help: Lists available commands.
- /WebP ver: Shows plugin version and checks for updates.
- /WebP dev: Displays plugin developer information.
- /WebP reload: Reloads the plugin configuration.
- /WebP reset: Resets the plugin configuration.
- /WebP stopweb: Stops the PHP web server.
- /WebP startweb: Starts the PHP web server.
- /WebP reloadweb: Reloads the PHP web server.
Permissions:
- web.show: Permission to use /WebP.
- web.help: Permission to use /WebP help.
- web.ver: Permission to use /WebP ver.
- web.dev: Permission to use /WebP dev.
- web.reload: Permission to use /WebP reload.
- web.reset: Permission to use /WebP reset.
- web.stopweb: Permission to use /WebP stopweb.
- web.startweb: Permission to use /WebP startweb.
- web.reloadweb: Permission to use /WebP reloadweb.
- web.*: Grants permission to all commands.
Feel free to reach out on Discord for any assistance or feedback!