Shipyrd documentation
Guides for setting up Shipyrd, wiring it into your deploy pipeline, and getting the most out of the dashboard.
New here?
Start with the overview to understand what Shipyrd is and when a team should reach for it. Then pick the integration that matches how you ship.
Send deploys to Shipyrd
Pick the path that matches your stack. Each guide walks through a working setup end to end.
Plain HTTP (cURL)
Notify Shipyrd from any language or CI with a single HTTP POST.
Ruby gem
Drop-in for Kamal. Add the gem and two hooks; Shipyrd is notified on every deploy.
Docker container
Run the Shipyrd gem as a container — no Ruby required on the host.
Honeybadger
Already on Honeybadger? Pipe its deploy events straight into Shipyrd.
AppSignal
Connect AppSignal so its deploy markers also appear in Shipyrd.
Rollbar
Forward Rollbar deploy notifications into Shipyrd alongside your other sources.
Configure your dashboard
Deploy locks & blocking
Prevent two people from shipping at once. Manual locks or automatic.
Office hours
Auto-lock destinations outside the hours your team is around to fix things.
On Deck
See which commits are merged but not yet shipped for any destination.
Deploy badges
Embeddable shields showing the current deploy state and lock status for any destination.
Notifications
Push deploy and lock events out to Slack channels or any webhook URL.
Slack bot
Install the Shipyrd Slack app and run lock/status commands without leaving Slack.
Self-hosting
Run Shipyrd's Community Edition on your own infrastructure.