Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ultrabalancer.com/llms.txt

Use this file to discover all available pages before exploring further.

# One-command install - automatically detects your OS and architecture
curl -sSL https://package.ultrabalancer.com/install.sh | sh
That’s it! The installer will:
  1. Detect your operating system (Linux, macOS, Windows)
  2. Detect your architecture (x86_64, ARM64)
  3. Download the latest release from GitHub
  4. Install to /usr/local/bin/
Verify the installation: 
ultrabalancer --version

​
Manual Installation

​
Linux (x86_64)

# Download the latest release
curl -LO https://github.com/bas3line/ultrabalancer/releases/latest/download/ultrabalancer-3.0.0-x86_64-unknown-linux-gnu.tar.gz

# Extract
tar -xzf ultrabalancer-3.0.0-x86_64-unknown-linux-gnu.tar.gz

# Install
sudo mv ultrabalancer-3.0.0-x86_64-unknown-linux-gnu/ultrabalancer /usr/local/bin/

​
macOS

Apple Silicon (M1/M2/M3): 
curl -LO https://github.com/bas3line/ultrabalancer/releases/latest/download/ultrabalancer-3.0.0-aarch64-apple-darwin.tar.gz
tar -xzf ultrabalancer-3.0.0-aarch64-apple-darwin.tar.gz
sudo mv ultrabalancer-3.0.0-aarch64-apple-darwin/ultrabalancer /usr/local/bin/
Intel: 
curl -LO https://github.com/bas3line/ultrabalancer/releases/latest/download/ultrabalancer-3.0.0-x86_64-apple-darwin.tar.gz
tar -xzf ultrabalancer-3.0.0-x86_64-apple-darwin.tar.gz
sudo mv ultrabalancer-3.0.0-x86_64-apple-darwin/ultrabalancer /usr/local/bin/

​
Windows

Download the latest release from the GitHub Releases page and extract the ZIP file.

​
Build from Source

Requires Rust 1.75+: 
# Install Rust if you don't have it
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source $HOME/.cargo/env

# Clone and build
git clone https://github.com/bas3line/ultrabalancer.git
cd ultrabalancer
cargo build --release

# Install
sudo cp target/release/ultrabalancer /usr/local/bin/

​
Available Platforms

PlatformStatusFile Format
Linux x86_64✅ Availabletar.gz
Linux ARM64Build from source-
macOS ARM64Build from source-
macOS x86_64Build from source-
Windows x86_64Build from source-

​
Package Server API

Our package server provides programmatic access to releases: 
# Get latest version
curl https://package.ultrabalancer.com/version
# {"version":"3.0.0","name":"UltraBalancer v3.0.0","repo":"bas3line/ultrabalancer"}

# Get download URL for a platform
curl https://package.ultrabalancer.com/latest/linux-x86_64
# {"version":"3.0.0","filename":"ultrabalancer-3.0.0-x86_64-unknown-linux-gnu.tar.gz","url":"https://github.com/..."}

# Download install script
curl -o install.sh https://package.ultrabalancer.com/install.sh

​
Upgrading

# Re-run the installer
curl -sSL https://package.ultrabalancer.com/install.sh | sh

# Or download manually
curl -LO https://github.com/bas3line/ultrabalancer/releases/latest/download/ultrabalancer-3.0.0-x86_64-unknown-linux-gnu.tar.gz

​
Next Steps

Quickstart

Get running in 2 minutes

Configuration

Configure for production