DocsGetting Startedinstallation

Installation Guide

Get RelayCraft up and running on macOS, Windows, or Linux in minutes.

System Requirements

  • macOS: 10.15 (Catalina) or later (Intel & Apple Silicon)
  • Windows: 10/11 (64-bit)
  • Linux: Ubuntu 20.04+, Fedora 32+, Arch Linux

Download & Install

macOS

The easiest way to install on macOS is via Homebrew:

brew install --cask relaycraft

Windows

You can use Winget to install RelayCraft:

winget install RelayCraft

Alternatively, download the .msi installer from our GitHub Releases page.

Important

On Windows, you may need to allow RelayCraft through Windows Defender Firewall on first launch.

Post-Installation: Certificate Setup

After installation, the most critical step is configuring the root certificate to decrypt HTTPS traffic. RelayCraft attempts to install this automatically, but manual steps are often required for mobile devices.

See the Quick Start guide for certificate details.