Installation

Detailed installation instructions for all platforms

2 minute read

Installation Methods

ProxLB can be installed via several methods depending on your environment and preferences.

Native Packages (Recommended)

Debian/Ubuntu (.deb)

The recommended installation method for Debian-based systems using the official credativ repository:

# 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 stable 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

Snapshot builds

If you want to test the latest development builds, use Suites: snapshots instead of Suites: stable in the repository configuration above.

Python Package (pip)

Install from PyPI:

pip install proxlb

For a system-wide installation:

sudo pip install proxlb

It’s recommended to use a virtual environment:

python3 -m venv /opt/proxlb
source /opt/proxlb/bin/activate
pip install proxlb

Container Images

Docker

docker pull credativ/proxlb:latest

docker run -d \
  --name proxlb \
  -v /path/to/proxlb.conf:/etc/proxlb/proxlb.conf:ro \
  credativ/proxlb:latest

Podman

podman pull docker.io/credativ/proxlb:latest

podman run -d \
  --name proxlb \
  -v /path/to/proxlb.conf:/etc/proxlb/proxlb.conf:ro \
  docker.io/credativ/proxlb:latest

From Source

Clone and install from the GitHub repository:

git clone https://github.com/credativ/ProxLB.git
cd ProxLB
pip install -e .

Post-Installation

After installation, you’ll need to:

Create the configuration file: Copy the example configuration to /etc/proxlb/proxlb.conf
Set up API credentials: Configure your Proxmox API access
Test the configuration: Run proxlb --dry-run to verify everything works
Enable the service: Start the systemd service for automatic balancing

See the Configuration Guide for detailed configuration options.

Upgrading

Native Packages

sudo apt update && sudo apt upgrade proxlb

pip

pip install --upgrade proxlb

Container

docker pull credativ/proxlb:latest
docker stop proxlb && docker rm proxlb
# Re-run with the new image