Skip to main content

Installation

OpenVLE runs as a Docker Compose stack — a single repository contains all required services (backend, frontend, worker, databases). Before installing OpenVLE, the external dependencies (Proxmox VE, optionally Guacamole) must be set up.

Before you begin, make sure your server meets the requirements and Docker is installed.

Installation Order​

  1. Requirements — System prerequisites and Docker installation
  2. Proxmox VE Integration — Set up VM infrastructure (required)
  3. Apache Guacamole Integration — Set up remote desktop access (optional, recommended)
  4. OpenVLE — Set up and configure the application via Docker Compose
  5. Configuration Reference — Complete reference of all environment variables
  6. Reverse Proxy — Configure SSL termination and routing
  7. Moodle Integration — Connect to Moodle (optional)
Note on Optional Components
  • Proxmox VE is required. Without proper Proxmox configuration, OpenVLE will start but all actions involving VMs and VM templates will fail.
  • Apache Guacamole is optional but recommended. Without Guacamole, OpenVLE can be used to manage VMs and VM templates, but without web-based remote desktop access.
  • Moodle integration is entirely optional. If not used, the Moodle-related elements will not be displayed in the user interface.