Relay documentation

Relay is a modern web IRC client designed for self-hosting. This site is the technical reference for running and using Relay. For product features, screenshots, downloads, and plans, visit relayirc.com.

Getting started Install Relay, create the first administrator, and open the web client. Using Relay Connect to networks, manage conversations, notifications, profiles, and files. Administering Relay Configure users, storage, authentication, media, integrations, and public mode. Contributing Build the project, run a development environment, and report security issues.

Installation examples pin the published 0.11.5 image. Guides identify newer features that require a master build. See Relay downloads for current releases.

Common tasks

• Install with Docker or Docker Compose
• Create the first administrator
• Use Relay in a browser or install the PWA
• Configure message storage and retention
• Review IRCv3 support
• Troubleshoot known compatibility limitations

Need product information? See Features, Download, and the Roadmap on the Relay website.