Skip to main content

Installation

Step 1: Download the Plugin

Download the latest ZyveraWeb.jar from the official release channel. The file is a fat JAR (ShadowJar) containing all bundled dependencies.

Step 2: Place the JAR

Copy ZyveraWeb.jar into your server's plugins/ directory:

server-root/
├── plugins/
│   ├── ZyveraWeb.jar     ← Place here
│   └── ...
├── server.jar
└── ...

Step 3: Restart Your Server

Restart or start your Minecraft server. On first startup, ZyveraWeb will:

  1. Create its data folder: plugins/ZyveraWeb/
  2. Generate a default config.yml
  3. Create the default static website in plugins/ZyveraWeb/site/default/
  4. Create example Node.js projects in plugins/ZyveraWeb/site/
  5. Create an SSL certificate folder: plugins/ZyveraWeb/ssl/
  6. Start the web server (default: http://0.0.0.0:8080)

Step 4: Verify Installation

Run the following command in-game or from console:

/zyveraweb

Expected output:

=== ZyveraWeb Info ===
Version: <version>
Web Server: Running
SSL: Disabled

Step 5: Access Your Website

Open a browser and navigate to http://your-server-ip:8080. You should see the default ZyveraWeb welcome page showing a list of online players.

Directory Structure After Installation

plugins/ZyveraWeb/
├── config.yml           # Main configuration
├── site/                # All websites and projects
│   ├── default/         # Default static website
│   │   ├── index.html
│   │   ├── style.css
│   │   └── script.js
│   ├── demo/            # Node.js demo project
│   │   ├── package.json
│   │   ├── server.js
│   │   └── public/
│   │       ├── index.html
│   │       ├── style.css
│   │       └── app.js
│   └── react-demo/      # React demo project
│       ├── package.json
│       ├── server.js
│       └── public/
│           ├── index.html
│           └── style.css
└── ssl/                 # SSL certificates (empty until configured)

Uninstalling

To uninstall ZyveraWeb, simply remove the JAR from plugins/ and restart your server. Your website files and configuration will remain in plugins/ZyveraWeb/ unless manually deleted.

No comments to display

Back to top