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, 8.x or 9.x)
  • API access credentials for your Proxmox cluster

Quick Installation

Debian/Ubuntu

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

# Add repository
echo "deb [signed-by=/etc/apt/keyrings/proxtools-archive-keyring.gpg] \
https://packages.credativ.com/public/proxtools stable main" \
| sudo tee /etc/apt/sources.list.d/proxlb.list

# Update & install
sudo apt-get update
sudo apt-get -y install proxlb

# Copy example config
sudo cp /etc/proxlb/proxlb_example.yaml /etc/proxlb/proxlb.yaml

# Adjust the config to your needs
sudo vi /etc/proxlb/proxlb.yaml

# Start service
sudo systemctl start proxlb

Docker

# Pull the image
docker pull ghcr.io/credativ/proxlb:latest
# Download the config
wget -O proxlb.yaml https://raw.githubusercontent.com/gyptazy/ProxLB/refs/heads/main/config/proxlb_example.yaml
# Adjust the config to your needs
vi proxlb.yaml
# Start the ProxLB container image with the ProxLB config
docker run -it --rm -v $(pwd)/proxlb.yaml:/etc/proxlb/proxlb.yaml proxlb

Next Steps