Client apps

Relay works in a browser or as an installed Progressive Web App (PWA). Both connect to an existing Relay server; installing the PWA does not deploy one.

Current master removes native desktop support. Use the browser or PWA for current deployments. Historical desktop packages remain release-specific; see the Relay Download page.

Release 0.11.2 provides desktop packages for Linux x86-64, Windows x86-64, and Apple Silicon macOS (DMG and ZIP) on its release page.

Desktop client (0.11.2)

Launch the desktop client and enter the full URL of your Relay server, including https://. The desktop client can store uploads in Relay or use Catbox for public links; browser and PWA clients always use Relay storage.

macOS quarantine

Current macOS packages may be unsigned. If Gatekeeper quarantines Relay, put Relay.app in /Applications, then run:

xattr -dr com.apple.quarantine /Applications/Relay.app

Only run this command for a package you obtained from the official Download page.

Linux archive

Extract the downloaded archive and launch its binary:

tar -xzf relay-desktop-linux-amd64.tar.gz
cd relay-desktop-linux-amd64
chmod +x relay-desktop
./relay-desktop

Install the PWA

Open your Relay server URL, not this documentation site.

iPhone and iPad

1. Open the server URL in Safari.
2. Tap Share.
3. Tap Add to Home Screen.
4. Confirm the app name and tap Add.

Android

1. Open the server URL in a browser that supports PWA installation.
2. Use the install prompt, or choose Install app or Add to Home screen from the browser menu.
3. Confirm the installation.

Relay also offers an install action under Settings > General > Native app on supported browsers.