Documentation

Vyron Deployment Docs

Host your main website and API yourself, while client servers download and run their own local Vyron panel.

Quickstart

Run this on the client machine that should host its own panel:

curl -fsSL https://api.vyronpanel.com/download/installer | sudo bash

Installer URL

Your API subdomain serves the installer script. You can use either URL:

  • /download/installer
  • /download/installer.sh

What Gets Installed

  • Downloads full webpanel package from API download routes.
  • Automatically installs Node.js and npm first if they are missing.
  • Installs Node.js dependencies on the client server.
  • Creates local data directories under /opt/vyron-panel.
  • Registers and starts vyron-panel.service via systemd.
  • Runs panel locally with node /opt/vyron-panel/server.js.

Panel Guide

  1. Login with your admin account and open New Server.
  2. Select loader/version, set port and RAM, then save.
  3. Click Start and monitor console for first-boot errors.
  4. Use tabs for Files, Config, Players, and Monitoring.
  5. Install plugins/mods from Addons or upload them manually.
  6. Use Backups and Schedules for safe automation.

Recommended first setup: create one test server first, verify startup, then clone your settings for production nodes.

Make Server Online

Best option for most users is Playit.gg because it avoids router setup and works behind CGNAT.

Playit.gg (recommended)

  1. Create an account at playit.gg and create a new tunnel.
  2. Select TCP tunnel, target host 127.0.0.1, target port = your Minecraft server port (for example 25565).
  3. Install and run Playit agent on the same machine as Vyron panel.
  4. Start your Minecraft server in Vyron.
  5. Share the generated Playit hostname with players.

Direct Port Forwarding (router)

  1. Set static LAN IP for your host machine.
  2. Forward TCP port 25565 (or your chosen server port) to that LAN IP.
  3. Allow that port in OS firewall.
  4. Use your public IP (or domain DNS record) for players.

Security tip: only open ports you need and keep Java/plugins updated.

Requirements

  • Linux server with systemd.
  • Root access (or sudo) for installation.
  • Outbound internet access to your API host.
  • Java 17+ on machines that will run Minecraft instances.
  • Node.js does not need to be preinstalled because the installer will try to install it automatically.

Required API Routes

GET /download/installer
GET /download/installer.sh
GET /download/webpanel-files.txt
GET /download/webpanel/file/*
GET /health

Environment Overrides

VYRON_PANEL_URL="https://api.vyronpanel.com" \\
VYRON_INSTALL_DIR="/opt/vyron-panel" \\
VYRON_PANEL_PORT="4170" \\
bash installer.sh

Common Crashes

  • Port already in use: Address already in use or Failed to bind to port. Fix by changing server port or stopping conflicting process.
  • Java mismatch: UnsupportedClassVersionError. Fix by using the required Java version (usually 17 or 21).
  • Out of memory: OutOfMemoryError or java heap space. Raise RAM limit and reduce heavy mods/plugins.
  • EULA not accepted: startup says agree to EULA. Set eula=true in eula.txt.
  • Corrupt world or bad mod/plugin: early init NPEs (for example overworld() is null). Test with clean world and disable recent mods/plugins.
  • Forge/Linux-only mod issue: crash mentions Only supported on Linux or init exceptions. Remove incompatible dependency for your OS/runtime.

Troubleshooting

  • If install fails, check: systemctl status vyron-panel.service
  • To view logs: journalctl -u vyron-panel.service -f
  • To restart: systemctl restart vyron-panel.service