Getting Started

Get ProxLB up and running in minutes

  less than a minute  

Prerequisites

Before installing ProxLB, ensure you have:

  • A Proxmox VE cluster (version 7.x or 8.x)
  • API access credentials for your Proxmox cluster
  • Python 3.8 or higher (if installing via pip)

Quick Installation

The fastest way to get started is using the native packages:

Debian/Ubuntu

# Install the repository signing key
sudo wget -O /etc/apt/keyrings/proxtools-archive-keyring.gpg \
  https://packages.credativ.com/public/proxtools/archive-keyring.gpg

# Add the repository
echo "Types: deb
URIs: https://packages.credativ.com/public/proxtools
Suites: stable
Components: main
Signed-By: /etc/apt/keyrings/proxtools-archive-keyring.gpg" | \
sudo tee /etc/apt/sources.list.d/proxtools.sources

# Install ProxLB
sudo apt update
sudo apt install proxlb

Via pip

pip install proxlb

Basic Configuration

After installation, configure ProxLB by editing /etc/proxlb/proxlb.conf:

[proxmox]
api_host = your-proxmox-host.example.com
api_user = root@pam
api_pass = your-password
# Or use token authentication:
# api_token_id = your-token-id
# api_token_secret = your-token-secret

[balancing]
mode = memory  # Options: cpu, memory, combined
dry_run = true  # Set to false to enable actual migrations

First Run

Test your configuration with a dry run:

proxlb --dry-run

This will show you what migrations ProxLB would perform without actually moving any VMs.

Enable the Service

Once satisfied with the configuration, enable the systemd service:

sudo systemctl enable proxlb
sudo systemctl start proxlb

Next Steps