Deploy Overview
For complete deployment instructions, use the Daemon documentation.
Run Relay as a managed background service (daemon) on a workstation or remote Linux server. IT controls shared configuration, routing, and telemetry; workers run on each userβs machine.
Deploy managed Codex and Claude Code integrations using the guides below.
General Steps
Choose a deployment and install Relay
Choose a deployment model and install the Relay CLI on the service host and clients. Remote deployments need network connectivity in both directions between the daemon and client workers.
Prepare managed configuration and credentials
Follow Configuration and Managed Clients to prepare shared settings and a separate routing credential for each user-machine identity. System settings take priority over personal configuration.
Deploy the service and clients
Follow the path for your deployment:
- Local workstation: Follow the runbook for Windows, macOS, or Linux.
- Remote Linux server: Skip the local runbooks. Follow Deploy the Daemon, then Deploy Clients.
Verify before rollout
Complete Verify Worker-Backed Operation with a managed test session before rollout.
For updates, removal, and troubleshooting, use Operations and Troubleshooting.