FerryDocs
Guides

Auto-deploy from GitHub

With auto-deploy, each push to a branch on GitHub deploys the services that track it.

Edit on GitHub
git pushto mainGitHubpush eventferryd/hooks/githubNew deploytrigger: webhook

You push a commit to the branch.

1 / 4

When you to a , GitHub sends a push event to the endpoint of Ferry: /hooks/github. Ferry checks the . Then Ferry deploys the of the push for each that tracks this and this branch.

Create a service that deploys on a push

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

is on by default. The server also needs a , and GitHub needs the address of the webhook.

In this section

Before you startWhat GitHub must reach on your server.Set up the webhookThe secret, the service, the webhook, the first push.Which services a push deploysThe four conditions, and what Ferry ignores.Deploy hooksDeploy from your CI after the tests pass.

Problems with repositories

A repository is not in the list, or a deploy cannot clone it.

Before you start

GitHub must reach the webhook endpoint of your Ferry server through HTTPS.

On this page

Create a service that deploys on a pushIn this section