Getting Started with Relay Client

The Relay client is a modern desktop chat application built with Electron. It connects to self-hosted Relay servers, giving you complete control over your chat experience while maintaining a sleek, user-friendly interface.

Download and Installation

System Requirements

  • Windows: Windows 10 or later (64-bit)
  • Linux: Ubuntu 18.04+, Debian 10+, or equivalent

Download Options

Download Pre-built Application

  1. Visit the Relay Client Releases page
  2. Download the appropriate installer for your operating system:
    • Windows: Relay-Setup-x.x.x.exe
    • Linux: Relay-x.x.x.AppImage or relay_x.x.x_amd64.deb

Installation Steps

  • Run the downloaded Relay-Setup-x.x.x.exe file
  • Follow the installation wizard prompts
  • Launch Relay from the Start Menu or Desktop shortcut

Windows may show a security warning for unsigned applications. Click "More info" and then "Run anyway" to proceed with installation.

Initial Setup

First Launch

When you first launch Relay, you'll see the home screen with no servers connected. The interface includes:

  • Sidebar: Navigation between servers and settings
  • Main area: Server list and connection status
  • Breadcrumb: Current location indicator

Joining Your First Server

To connect to a Relay server, you'll need:

  • Server URL: The address of the Relay server (e.g., http://192.168.1.100:8080)

  • Username: Your desired username (must be unique on the server)

  • Nickname: Your display name (can be changed later)

  • Invite Code: A valid invite code from the server administrator

Step-by-Step Connection Process

  • Click "Join Server" button on the home screen or in the sidebar

  • Fill in the connection details: - Server URL: Enter the complete URL including protocol (http:// or https://) - Username: Choose a unique identifier (alphanumeric characters recommended) - Nickname: Your display name that others will see - Invite Code: Paste the invite code provided by the server admin

  • Click "Join Server" to initiate the connection

  • Wait for connection: The client will generate cryptographic keys and authenticate with the server

Once connected successfully, you'll be automatically redirected to the server's main channel and can start chatting immediately!

Understanding Server Connection

Connection Status Indicators

  • Green dot: Server is online and connected
  • Red dot: Server is offline or unreachable
  • "Connecting...": Attempting to establish connection
  • "Retrying": Automatically retrying failed connections

Automatic Features

Key Generation

Each server connection uses unique Ed25519 cryptographic keys for secure authentication.

Profile Sync

Your profile picture is automatically uploaded to new servers if you have one set.

WebSocket Connection

Real-time messaging is established through secure WebSocket connections.

Managing Multiple Servers

Server List Organization

Relay supports connecting to multiple servers simultaneously:

  • Drag and drop servers in the sidebar to reorder them
  • Server icons display custom server branding when available
  • Connection status is shown for each server individually

Server Management Actions

Right-click on any server in the sidebar to access:

  • Export Identity: Save your cryptographic identity for backup

  • Retry Connection: Manually retry failed connections
  • Leave Server: Disconnect and remove the server

Troubleshooting Common Issues

Connection Problems

Incorrect Server URL Format:

  • Ensure you include the protocol: http:// or https://
  • Include the port if not using standard ports: http://server.com:8080
  • Verify the server address with your administrator

Common URL Examples:

http://localhost:8080          # Local server
http://192.168.1.100:8080     # Local network server
https://chat.example.com      # Public server with SSL

Performance Tips

  • Close unused servers to reduce memory usage

  • Limit concurrent connections if experiencing slowdowns

  • Update regularly for performance improvements and bug fixes

Next Steps

Once you've successfully connected to your first server:

Need help setting up a Relay server? Check out our Server Setup Guide to host your own chat server.