Skip to content

Installation Guide

This section provides detailed instructions for all supported installation methods. All methods support High Availability (HA) distributed cluster deployments - enabling fault-tolerant relay networks where users connect to a single endpoint but benefit from automatic failover and data redundancy across multiple nodes.

Installation Methods Overview

  • Quick Start: Use the automated script for a fast setup
  • Best for: Users who want to get up and running quickly with minimal configuration
  • Time: 5-10 minutes
  • Difficulty: Easy

Docker Installations

  • Docker Standalone: Manual setup for a single-node Docker deployment
  • Docker Distributed: Manual setup for a multi-node, high-availability Docker deployment
  • Best for: Users familiar with Docker who want containerized deployments

Bare Metal Installation

  • Bare Metal Installation: Advanced installation directly on servers without Docker
  • Best for: Users who need maximum performance, control, or can’t use Docker

Prerequisites

Before installing, ensure your system meets the Getting Started requirements:

  • Operating System: Ubuntu 22.04 LTS or newer (other Linux distributions may work)
  • CPU: 2+ cores (4+ recommended for production)
  • RAM: 4+ GB (8+ GB recommended for production)
  • Storage: 20+ GB SSD (50+ GB recommended for production)
  • Network: Stable internet connection

Next Steps

  1. Review Requirements: Check Getting Started for detailed system requirements
  2. Choose Method: Select the installation method that fits your needs
  3. Follow Guide: Use the specific installation guide for your chosen method
  4. Configure: Customize your relay settings using Configuration Guide
  5. Operate: Learn about operations in Performance and Troubleshooting

Installation Pages

  • Quick Start: /quick-start
  • Docker Standalone: /docker-standalone
  • Docker Distributed: /docker-distributed
  • Bare Metal: /bare-metal