Set up the webhook

Make a secretCopy Anchor Link

openssl rand -hex 32

The command prints a random webhook secret.

Give the secret to ferrydCopy Anchor Link

Start ferryd with the flag --github-webhook-secret, or with the variable FERRY_GITHUB_WEBHOOK_SECRET.

ferryd --base-domain apps.example.com \
  --proxy-addr 0.0.0.0:80 --https-addr 0.0.0.0:443 --acme-email you@example.com \
  --dashboard-host ferry.apps.example.com \
  --github-webhook-secret <the secret>

ferry info then shows GitHub webhook: enabled. Without a secret, /hooks/github answers 404.

Create a service from the repositoryCopy Anchor Link

ferry create api --repo https://github.com/you/api --branch main --follow

Auto-deploy is on by default. The default branch is main. For a private repository, see Private repositories.

Add the webhook in GitHubCopy Anchor Link

In the repository, open Settings → Webhooks → Add webhook. Enter these values:

GitHub sends a ping first. Ferry answers 200 with {"ok":true}. The webhook shows a green check.

PushCopy Anchor Link

Push a commit to main. Then list the deploys:

ferry deploys api

ID                         STATUS      TRIGGER   COMMIT                   CREATED    DURATION
dep-c2225fad527c4b919c1b   deploying   webhook   fe41834 Add a comment    just now   1s
dep-a53de39943a841aca2c3   live        create    d258434 Initial commit   just now   2s

The new deploy has the trigger webhook. It builds the exact commit of the push.