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.

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

# 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

Container Images / Docker

Available images can be found at the GitHub packages page.

# Pull the image (GitHub Container Registry)
docker pull ghcr.io/credativ/proxlb:latest
# Alternatively, use the Docker Hub mirror
docker pull 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

Docker Compose

services:
  proxlb:
    image: ghcr.io/credativ/proxlb:latest
    container_name: proxlb
    restart: unless-stopped
    volumes:
      - ./proxlb.yaml:/etc/proxlb/proxlb.yaml:ro

PyPI

ProxLB is also available via PyPI:

pip install proxlb

From Source

Clone and run directly from the GitHub repository:

git clone https://github.com/credativ/ProxLB.git
cd ProxLB

Adjust the config file to your needs:

vi config/proxlb.yaml

Start ProxLB:

python3 proxlb/main.py -c config/proxlb.yaml

Post-Installation

After installation, you’ll need to:

  1. Create the configuration file: Copy the example configuration to /etc/proxlb/proxlb.yaml
  2. Set up API credentials: Configure your Proxmox API access
  3. Enable the service: Start the systemd service for automatic balancing

See the Configuration Guide for detailed configuration options.

Upgrading

Native Packages

sudo apt-get update && sudo apt-get upgrade proxlb

Container

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