ZyveraWeb
Advanced web hosting plugin for Minecraft servers.
Index
Advanced Web Hosting for Minecraft Servers ZyveraWeb transforms your Minecraft server into a full...
Introduction
What Is ZyveraWeb
ZyveraWeb is an advanced web hosting plugin for Minecraft servers that embeds a complete HTTP/HTT...
Features Overview
Web Server HTTP/HTTPS — Full HTTP/1.1 support with optional TLS 1.3/1.2 encryption. Configurable...
Supported Platforms
ZyveraWeb uses a platform abstraction architecture with a single core and platform-specific adapt...
Architecture Overview
ZyveraWeb uses a layered architecture with a platform-independent core and platform-specific adap...
Installation Setup
System Requirements
Minimum Requirements Requirement Value Java JDK 21 or later Minecraft Server Spigot/Pape...
First Run
What Happens on First Run When ZyveraWeb starts for the first time with an empty plugins/ZyveraWe...
Installation
Step 1: Download the Plugin Download the latest ZyveraWeb.jar from the official release channel. ...
Configuration
Config YML Reference
The main configuration file is located at plugins/ZyveraWeb/config.yml. It uses the YAML format a...
Rate Limiting
ZyveraWeb uses a token bucket algorithm to rate-limit requests per IP address. Each bucket is ref...
Server Settings
The web server is configured at the root level of config.yml. Settings host The IP address the we...
Virtual Hosts
The sites: section defines virtual hosts, allowing you to serve different content based on the Ho...
SSL Configuration
ZyveraWeb supports HTTPS with TLS 1.3 and TLS 1.2. SSL is configured per-site rather than globall...
Web Server
Starting and Stopping
The web server lifecycle can be managed both automatically (plugin startup/shutdown) and manually...
Static File Hosting
The FileHandler serves static files from a configured root directory. This is the most common use...
Reverse Proxy
The reverse proxy handler forwards incoming HTTP requests to an upstream server. This is useful f...
Virtual Hosting
The virtual host handler is the router that sits in front of all site-specific handlers. It match...
HTTP vs HTTPS
ZyveraWeb supports both plain HTTP and encrypted HTTPS. HTTPS is enabled per-site rather than wit...
Node.js Runtime
Overview
ZyveraWeb can run server-side JavaScript directly inside the JVM using GraalVM Polyglot (GraalJS)...
Project Structure
A Node.js project in ZyveraWeb follows a specific directory layout. Directory Layout plugins/Zyve...
server.js API
The server.js file is the backend entry point for a Node.js project. It must define a global hand...
NPM Packages
ZyveraWeb includes a pure-JVM npm client that can download and install npm packages without requi...
React and SSR
ZyveraWeb supports React applications in two modes: 1. Single Page Application (SPA) Build your R...
Example Projects
ZyveraWeb creates two example Node.js projects on first run to help you get started. Demo Project...
SSL ACME
Automatic SSL
ZyveraWeb includes a built-in ACME v2 client that can obtain free SSL certificates from Let's Enc...
HTTP Challenge
The HTTP-01 challenge is the simplest way to validate domain ownership. Let's Encrypt makes an HT...
DNS Challenge
The DNS-01 challenge validates domain ownership by requiring you to add a specific DNS TXT record...
Manual SSL
If you prefer not to use Let's Encrypt, or if you have an existing certificate, you can configure...
API Endpoints
Players API
Endpoint: GET /api/players Returns a comma-separated list of currently online player names. Avail...
Custom Endpoints
ZyveraWeb comes with a set of built-in HTTP endpoints. These are registered internally and are no...
PlaceholderAPI
Endpoint: GET /api/placeholder Resolves PlaceholderAPI placeholders via HTTP. Available only on t...
Commands Permissions
ZyveraWeb Command
The main admin command for plugin information, configuration reload, and Node.js package manageme...
ACME Command
Manages the Let's Encrypt ACME workflow for automatic SSL certificate issuance. Usage /zyveraweb ...
WebServer Command
Controls the web server lifecycle — start, stop, and restart. Usage /zyveraweb server <start | st...
Permissions Reference
Permission Nodes Permission Default Description zyveraweb.info Everyone Access to /zyveraw...
Platform Support
Bukkit Spigot Paper
The primary platform for ZyveraWeb. Supports servers running Minecraft 1.16 and above. Platform F...
Folia
ZyveraWeb fully supports Folia, Paper's regionized server architecture, through FoliaLib. Automat...
BungeeCord
ZyveraWeb supports BungeeCord proxy servers version 1.16 and above. Platform Features Feature ...
Velocity
ZyveraWeb supports Velocity proxy servers version 3.3 and above. Platform Features Feature Sup...
Advanced Topics
Rate Limiting Deep Dive
Token Bucket Algorithm ZyveraWeb uses the token bucket algorithm for rate limiting, which is more...
CORS
Cross-Origin Resource Sharing (CORS) headers are applied to all responses. This controls which we...
Metrics Analytics
ZyveraWeb integrates with FastStats for anonymous usage metrics. This helps the developers unders...
Examples Tutorials
Static Website
This tutorial walks through creating a custom static website with ZyveraWeb. Step 1: Create Your ...
Node.js Backend
This tutorial shows how to create a Node.js project with a JavaScript backend and npm dependencie...
Reverse Proxy Setup
This tutorial shows how to use ZyveraWeb's reverse proxy to forward requests to an external servi...
HTTPS Setup
This tutorial walks through the full process of enabling HTTPS using Let's Encrypt's ACME service...