Skip to main content

Install Ludus

warning

Ludus will completely take over the machine! It should not be used for other tasks (i.e. Docker).

danger

Ludus is not supported on hosts that are connected to the network via WiFi. Please connect via ethernet.

Ludus can only be installed on a host that meets the following requirements:

  • x86_64 (aka amd64 aka 64-bit "Intel") CPU with a Passmark score > 6,000
  • Debian 12 or Proxmox 8 (If Proxmox, see this page for details)
  • Supports virtualization - vmx or svm in /proc/cpuinfo (nested virtualization is supported, but has a performance penalty)
  • Has at least 32 GB of RAM
  • Has at least 200 GB of disk space (fast NVMe recommended)
  • Root access
  • Internet access (not via WiFi)

Machines with lower specs than listed above may work, but are not tested/supported.

If you are installing Debian 12, the netinst ISO (scroll down to debian-12.x.x-amd64-netinst.iso) is recommended. At the screen below during install, uncheck Debain desktop environment and check SSH server.

A screenshot of the Debain 12 install page with SSH Server and standard system utilities checked

To install ludus, use the installer script on a Debian 12 machine as shown below. It will extract files into /opt/ludus and walk through the configuration values during install.

Don't trust the binaries?

Ludus binaries are built in CI, but you can always build them from source yourself.

ssh user@debian12

# All-in-one command
curl -s https://ludus.cloud/install | bash

# If you want to check out the install script
curl https://ludus.cloud/install > install.sh
cat install.sh
chmod +x install.sh
./install.sh

The install.sh script will install the ludus client, and optionally shell completions, and then prompt to install the server. Follow the interactive installer. If you are unsure of any option, just accept the default value. The installer will start and reboot the machine.

After the reboot, the install will continue automatically. To monitor its progress, ssh into the machine, elevate to root, and run ludus-install-status.

A gif of the ssh-ing into Debian 12 and running the installer

Customizing the install​

In advanced setups /opt/ludus/config.yml can be modified after install to accommodate different storage pools, ZFS, etc.

/opt/ludus/config.yml
---
proxmox_node: ludus               # The proxmox node/hostname for this machine
proxmox_invalid_cert: true        # Disables certificate checking when using the Proxmox API (default true because of the self signed certificates)
proxmox_interface: ens18          # The interface this machine uses to communicate to the internet
proxmox_local_ip: 203.0.113.136   # The IP address for this interface (will be set statically)
proxmox_public_ip: 203.0.113.136  # The public IP address to reach this machine (for use in cloud/NAT environments)
proxmox_gateway: 203.0.113.254    # The gateway this machine uses to reach the internet
proxmox_netmask: 255.255.255.0    # The netmask for the proxmox_interface
proxmox_vm_storage_pool: local    # The name of the VM storage pool - can be changed after install for custom pools
proxmox_vm_storage_format: qcow2  # The VM storage format - can be changed after install (i.e. raw)
proxmox_iso_storage_pool: local   # The storage pool used to store ISOs as they are downloaded for templates - can be changed after install
ludus_nat_interface: ludus        # The name of the interface Ludus will create on the proxmox host that Ludus will use as the "WAN" for range routers
prevent_user_ansible_add: false   # Set this to true to prevent non-admin users from adding Ansible roles or collections to the server