Getting Started

This guide covers the prerequisites for installing Shugur Relay. Ensure your system meets these requirements before proceeding with the installation.

Why Choose Shugur Relay?

Shugur Relay’s High Availability (HA) distributed cluster architecture provides unique advantages:

• Simplified Operations: Deploy once, connect everywhere - no client-side multi-relay management
• Automatic Failover: Built-in redundancy ensures 99.9%+ uptime without manual intervention
• Data Persistence: Your data lives across the cluster network, not on a single point of failure
• Enterprise Ready: Designed for production workloads with monitoring, metrics, and scalability

System Requirements

These are the minimum requirements to run Shugur Relay. For HA cluster deployments, these requirements apply per node. Production environments may require more resources based on usage.

Software Prerequisites

For Docker Installations (Recommended)

• Docker: Version 20.10 or newer.
• Docker Compose: Version 2.0 or newer.

curl -fsSL https://get.docker.com -o get-docker.sh
sh get-docker.sh

For Bare Metal Installations

• Go: Version 1.24 or newer.
• CockroachDB: Version v24.1.x.
• Git, Curl, Wget, OpenSSL.

Network Requirements

The following ports must be accessible on your server(s).

Next Steps

Now that you have reviewed the prerequisites, you are ready to install Shugur Relay.

[→] Proceed to the Installation Guide