Getting Started — Installation

Installation

Install the Switchyard Relay on your infrastructure in under 60 seconds.

The Switchyard Relay runs on any Linux server with Docker. Installation takes about 60 seconds.

Requirements

  • OS: Ubuntu 20.04+, Debian 11+, or any Linux distribution with systemd
  • Docker: 20.10+ (the installer will install Docker if not present)
  • Resources: 4GB RAM minimum, 20GB disk space
  • Network: Outbound HTTPS access to switchyard.cloud

Install

Run the installer:

curl -fsSL https://switchyard.cloud/install | sh

The installer will:

  1. Detect your OS and architecture
  2. Check for Docker (and install it if missing)
  3. Pull the switchyard/relay Docker image
  4. Run an interactive setup wizard
  5. Start the relay daemon via systemd

Configuration

During setup, you’ll be prompted for:

  • Switchyard token — found in your dashboard at Settings → Relay
  • AI provider API key — your Anthropic API key (stored encrypted locally)
  • Git credentials — GitHub PAT or SSH key for repository access

All secrets are encrypted at rest using AES-256-GCM with a locally generated key.

Verify

Check that the relay is connected:

switchyard status

You should see:

Relay Status: connected
Version:      1.0.0
Uptime:       2m 30s
Containers:   0 active

The relay should also appear as “Connected” in your dashboard at Settings → Relay.

Next steps

Previous ← Introduction Next Architecture →