Getting Started with Relay Server

The Relay Server is a high-performance backend application built with Go that provides real-time communication capabilities. Host your own chat server with complete control over your data and user experience.

Download and Installation

System Requirements

  • Linux: Ubuntu 18.04+, Debian 10+, CentOS 7+, or equivalent

  • Windows: Windows Server 2019+ or Windows 10+
  • RAM: 128MB minimum

  • Storage: 100MB available space minimum, much higher recommended for attachments

Download Options

Download Pre-built Server

  1. Visit the Relay Server Releases page
  2. Download the appropriate binary for your operating system:
    • Linux (x64): relay-server-linux-amd64
    • Windows (x64): relay-server-windows-amd64.exe

Installation Steps

  • Download the binary: wget https://github.com/RelayCore/relay-server/releases/latest/download/relay-server-linux-amd64
  • Make it executable: chmod +x relay-server-linux-amd64
  • Move to system path: sudo mv relay-server-linux-amd64 /usr/local/bin/relay-server
  • Verify installation: relay-server --version

For production deployments, consider creating a dedicated user account and systemd service for the server.

Initial Configuration

Configuration File

Create a configuration file to customize your server settings:

1
2
3
4
5
6
7
8
9
10
# config.yaml
name: "My Relay Server"
description: "A secure chat server"
allow_invite: true
max_users: 100
max_file_size: 52428800 # in bytes (50MB)
max_attachments: 10
icon: "server-icon.png"
port: ":8080"
tenor_api_key: "" # Optional: for GIF support

First Launch

Starting the Server

1
go run ./cmd/server/main.go

Next Steps

Once your server is running successfully:

Need help connecting clients? Check out our Client Setup Guide to connect your first users.