OS
Orbi Sports
Docs / OrbiBond Server
Installation Guide

Deploy OrbiBond Server

Self-host the OrbiBond bonding server on your own infrastructure with Docker. HTTPS, dashboard, and all features included out of the box.

Quick Start

Get a bonding server running in under a minute. The server image includes the web dashboard, HTTPS termination, and all streaming features.

1 Pull the image
docker pull orbibond/server:latest
2 Run the server
docker run -d \
  --name orbibond \
  --restart unless-stopped \
  -p 28000:28000/udp \
  -p 28080:28080 \
  -v orbibond-data:/app/data \
  orbibond/server:latest
3 Open the dashboard

Navigate to https://your-server:28080 in your browser. Accept the self-signed certificate warning on first visit.

First Login
Default Credentials
Username: admin
Password: admin

You will be prompted to set a new password on first login. After that, the setup wizard guides you through creating your first API key. Share this key with the OrbiBond app to start bonding.

Docker Compose

For production deployments, use Docker Compose for easier management.

docker-compose.yml
version: '3.8'

services:
  orbibond:
    image: orbibond/server:latest
    container_name: orbibond
    restart: unless-stopped
    ports:
      - "28000:28000/udp"    # Bonding protocol
      - "28080:28080"        # HTTPS dashboard
    volumes:
      - orbibond-data:/app/data
    environment:
      - ORBIBOND_LICENSE_KEY=your_license_key
      - SERVER_HOSTNAME=stream.example.com
    healthcheck:
      test: ["CMD", "curl", "-sf", "http://localhost:28080/api/health"]
      interval: 30s
      timeout: 5s
      retries: 3
      start_period: 10s

volumes:
  orbibond-data:
    driver: local
docker compose up -d
Configuration

Configure the server via environment variables passed to the container.

Variable Default Description
ORBIBOND_LICENSE_KEY "" License key for seat validation
ORBIBOND_HTTPS_PORT 28080 HTTPS port for dashboard and API
ORBIBOND_PORT 28000 UDP port for bonding protocol
SERVER_HOSTNAME orbibond.local Hostname for SSL certificate CN
ORBIBOND_DB /app/data/orbibond.db Path to SQLite database
ORBIBOND_LICENSE_FILE "" Path to offline license file (.orbilicense)
Network Ports
UDP 28000

Bonding protocol. Mobile apps connect here to establish bonded tunnels. Must be reachable from the internet.

TCP 28080

HTTPS dashboard and REST API. Used for server management, monitoring, and egress configuration.

SSL Certificates

The server runs HTTPS-only. A self-signed certificate is generated automatically on first start. For production, use your own certificate.

Mount custom certificates

Place your cert.pem and key.pem files in the SSL directory.

docker run -d \
  --name orbibond \
  -p 28000:28000/udp -p 28080:28080 \
  -v orbibond-data:/app/data \
  -v /path/to/certs:/app/data/ssl:ro \
  orbibond/server:latest

Upload via dashboard

Navigate to Settings in the dashboard to paste your PEM certificate and private key directly, or request a Let's Encrypt certificate.

Connect the App

Once your server is running, connect the OrbiBond mobile app:

  • Download the OrbiBond app from the App Store or Google Play
  • Enter your server address (e.g. stream.example.com)
  • Paste the API key from the setup wizard
  • Start streaming — the app automatically bonds all available connections
Data Persistence

All server state is stored in /app/data. Mount this as a Docker volume to persist data across container restarts.

/app/data/
orbibond.db — API keys, devices, usage, passwords
ssl/ — custom SSL certificates
Need Help?

Questions about deployment, configuration, or integration? We're here to help.