Docs are coming soon
We're writing the full documentation now. Until it lands, two guides cover how Relay works and how to run it yourself.
Available now
- The deploy loop — what happens between git push and healthy traffic.
- Self-hosting notes — what the control plane and agent need to run.
On the way
| Page | What it covers |
|---|---|
| Quickstart | Connect a repo, enroll a server, ship your first deploy. |
| GitHub Action reference | Every input and output of the relay-deploy action. |
| Agent reference | Install flags, systemd service, and troubleshooting. |
| Dashboard guide | Projects, servers, domains, secrets and members. |
| API reference | The REST endpoints behind the dashboard. |
In the meantime, the fastest way to see how it fits together is thedashboard.