WebPlugin | official php support | [ 1.13 - 26.2 ]

WEB SERVER PLUGIN

We have folia support!
heads up
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.

# ==============================
# WebPluginV2 Configuration
# Author: JumpWatch
# Discord support: https://discord.gg/9HDFz9vyv4
# ==============================

Settings:
  # ── Web Server Ports ──
  HTMLPORT: 25567
  PHPPort: 25568
  LocalFPM: 25569         # Very important if you decide to use PHP.

  # ── Server Settings ──
  ServerLocation: /home/container/   # Include trailing slash.
  IndexLocation: ""                  # Default: "" = /webplugin/php/
  ServerIP: localhost                # Used for PHP and HTML via /webp command.

  # ── Threading ──
  maxThreads: 2

  # ── Debug Settings ──
  debug: false                       # Shows debug log in /webplugin/logs/.

  # ── PHP Settings ──
  EnablePHP: false
  PHPFolderPermissionFix: false       # Runs `chown -R www-data`, auto disables after run.

  # PHP runtime library handling.
  # WebPlugin starts php-fpm with a generated php.ini and LD_LIBRARY_PATH.
  # Empty PHPExtensions means WebPlugin tries to detect enabled extension= lines
  # from the bundled php.ini for backwards compatibility. For the modular runtime,
  # prefer setting PHPExtensions here and let WebPlugin generate php.ini.
  PHPDetectExtensionsFromIni: false
  PHPPreflightCheck: true
  # Extensions must exist under phplinux/bin/php8/extension-packs/<name>/.
  # The modular runtime archive contains these packs, but only this list is loaded.
  PHPExtensions:
    - opcache
    - openssl
    - zlib
    - ctype
    - curl
    - mbstring
    # mbregex is built into mbstring; adding mbregex also maps to mbstring.
    - intl
    - fileinfo
    - pdo_sqlite
    - sqlite3
    - pdo_mysql
    - mysqli
    - zip
    - xml
    - dom
    - simplexml
    - xmlreader
    - xmlwriter
    - gd
    - exif
    - bcmath
    - calendar
    - sockets
    - ftp
    - tokenizer

  # Extra runtime library paths. The modular runtime reads base paths from
  # runtime-manifest.properties, so this is usually only for manual overrides.
  PHPExtraLibraryPaths: []

  # Optional compatibility mapping for old runtimes or manual native library overrides.
  # The modular runtime primarily uses each extension pack's extension.properties file.
  PHPExtensionLibraryPaths: {}

  # ── Dependencies Reminder ──
  # The modular PHP archive is self-contained and includes the native libs it needs
  # under phplinux/bin/php8/lib/base, lib/glibc/lib, and extension-packs/*/libs.
  # WebPlugin does not download GLIBC/LIBONIG/LIBZ as separate archives anymore.

  # ── HTML Settings ──
  EnableHTML: true                  # PHP can also serve HTML.

  # ── Auto Key ──
  Autokey: false                     # Not functional currently.

  # ── NGINX Configuration ──
  denyNginxConfigOverride: false

# ── SSL Configuration ──
SSLSettings:
  EnableSSL: false
  SSLPort: 25570
  SSLDomain: play.domain.com
  SSLPriv: priv-key.pem
  SSLPubl: pub-key.pem

# ── Linux PHP Runtime Settings ──
Linuxphpsettings:
  Errorfolder: /errors/            #UNUSED


# ── GitHub Repo Resources ──
GithubWebPluginPHPRepo: https://github.com/hypersmc/WebPluginV2Repo
GithubWebPluginPHPRepoFilename: WebPlugin-linux-PHP8.4.8-MODULAR.tar.gz
GithubWebPluginNGINXRepoFilename: WebPlugin-linux-NGINX-1.27.1-PRECOMPILED.tar.gz

# ── Internal ──
ConfigVersion: 17                  # DO NOT EDIT

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.

SSLSettings:
  EnableSSL: false
  SSLPort: 25570
  SSLDomain: domain.com
  SSLPriv: private-key.pem
  SSLPubl: public-key.pem

Linux PHP Settings:

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. <deprecated>
• /WebP startweb: Starts the PHP web server. <deprecated>
• /WebP reloadweb: Reloads the PHP web server. <deprecated>
• /WebP uploadlogs <debug:true|false> [includeConfig:true|false] [redactConfig:true|false] | Upload logs for debugging purposes

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. <deprecated>
• web.startweb: Permission to use /WebP startweb. <deprecated>
• web.reloadweb: Permission to use /WebP reloadweb. <deprecated>
• web.logupload: Permission to use /WebP uploadlogs.
• web.*: Grants permission to all commands.

Feel free to reach out on Discord for any assistance or feedback!

BSTATS: