FerryDocs
GuidesAuto-deploy from GitHub

Before you start

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

Edit on GitHub
Your server, with --dashboard-hostHTTPSGitHubProxyport 443API/hooks/github
GitHub reaches the webhook endpoint through the proxy

What you need

  • A Ferry server that GitHub can reach through .
  • The ferry , with a login to that server.

Why the dashboard host

The serves the endpoint. To open the API to GitHub, start ferryd with --dashboard-host, together with automatic HTTPS. Then the sends the requests for that to the API.

The Production setup guide shows the two settings.

The dashboard host opens the full API

--dashboard-host sends the dashboard, the REST API and the webhooks through the public proxy. Each API call still needs an or a signed-in session. But use it only with HTTPS. Then the password, the session and the tokens never travel in clear text.

Auto-deploy from GitHub

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

Set up the webhook

Give ferryd a secret, create the service, add the webhook in GitHub, then push.

On this page

What you needWhy the dashboard host