Setup

Installation Guide

Install VMNexor on a dedicated server or VM, configure the environment, activate licensing, and connect it to your Proxmox infrastructure.

VMNexor documentation is actively evolving. Some features, wording, and screenshots may change during beta.

Recommended deployment model

VMNexor should run on a dedicated VM or server separate from your Proxmox nodes. This keeps the control plane isolated from the hypervisor layer and makes upgrades, backups, and recovery cleaner.

Server requirements

  • Ubuntu or Debian server
  • PHP 8.4 or newer
  • MariaDB or MySQL
  • Nginx
  • Systemd
  • Outbound HTTPS access for licensing and updates
  • A domain name pointed at the VMNexor server

Infrastructure requirements

  • At least one Proxmox VE node or cluster
  • Working Proxmox API access
  • Storage configured for VM disks and templates
  • Network bridge or routed IP setup prepared
  • Templates created and tested before public sales

Run the installer

bash deploy/install-package.sh

Installer prompts

  • Panel domain and application URL
  • Application name
  • Database host, port, name, username, and password
  • Bootstrap admin user details
  • VMNexor API key
  • License key
  • Optional provider credentials
  • Mail sender details
  • Console relay port

What the installer configures

  • Shared application environment
  • Laravel application key
  • Database connection
  • Queue and scheduler services
  • Console relay service
  • Nginx virtual host
  • Storage and bootstrap cache links
  • Database migrations
  • Production cache state

Post-install commands

php artisan migrate --force\nphp artisan config:clear\nphp artisan cache:clear\nphp artisan route:clear\nphp artisan view:clear\nphp artisan config:cache\nsystemctl restart php8.4-fpm

Service checks

systemctl status php8.4-fpm --no-pager\nsystemctl status vmnexor-queue --no-pager\nsystemctl status vmnexor-scheduler --no-pager\nsystemctl status proxmox-console-relay --no-pager

Web checks

  • Open the VMNexor URL in a browser
  • Confirm the login page loads
  • Sign in with the bootstrap admin account
  • Check the admin dashboard loads without errors
  • Confirm the configured license state is healthy

After installation

  • Add Proxmox nodes
  • Add or verify IP pools
  • Register templates
  • Create plans
  • Test provisioning with a disposable service
  • Only connect billing automation after manual provisioning tests pass

Upgrade safety note

Before running updates in production, make sure the updater has the required sudo permissions, the shared license files exist, and recent backups of the database and shared configuration are available.