Documentation

Get Started with UltraBalancer

Everything you need to deploy and configure your load balancer

Quick Start

Get UltraBalancer running in minutes

Build from Source
Compile UltraBalancer with custom optimizations

Prerequisites

# Install dependencies
sudo apt-get update
sudo apt-get install build-essential cmake git
sudo apt-get install libssl-dev libevent-dev

Clone and Build

# Clone repository
git clone https://github.com/Megallm/ultrabalancer.git
cd ultrabalancer
# Build
mkdir build && cd build
cmake ..
make -j$(nproc)
# Install
sudo make install

Verify Installation

ultrabalancer --version
# UltraBalancer v1.0.0

Configuration

Configure UltraBalancer with YAML or JSON

Basic Configuration
Minimal config.yaml to get started
# config.yaml
listeners:
- name: "http"
address: "0.0.0.0"
port: 80
protocol: "http"
backends:
- name: "web-pool"
algorithm: "round_robin"
servers:
- address: "192.168.1.10"
port: 8080
weight: 1
- address: "192.168.1.11"
port: 8080
weight: 1
health_checks:
interval: 5
timeout: 2
path: "/health"
Advanced Config
SSL/TLS, rate limiting, circuit breakers
Examples
Real-world configuration examples
CLI Reference
Command-line options and flags

Running UltraBalancer

Start and manage your load balancer

Start the Load Balancer
# Start with config file
ultrabalancer -c /etc/ultrabalancer/config.yaml
# Start in daemon mode
ultrabalancer -c config.yaml -d
# Enable verbose logging
ultrabalancer -c config.yaml -v
Reload Configuration
# Hot reload without downtime
ultrabalancer reload
# Or send SIGHUP signal
kill -HUP $(cat /var/run/ultrabalancer.pid)
Check Status
# View runtime status
ultrabalancer status
# Check backend health
ultrabalancer health
Graceful Shutdown
# Drain connections and stop
ultrabalancer stop
# Or send SIGTERM signal
kill -TERM $(cat /var/run/ultrabalancer.pid)

Need More Help?

Explore our comprehensive documentation and community resources