FerryDocs

Connect GitHub

Ferry creates a GitHub App for your server. The app reads only the repositories that you choose.

Edit on GitHub
Your GitHub accountFerryGitHub Appprivate to youyou/apichosenyou/notesnot chosen

Ferry creates a GitHub App in your account. The app is private to your account.

1 / 3

A is an application of your own on GitHub. Ferry creates it for your server. You prepare nothing on GitHub.

Connect the account

Open the dialog

Click Connect GitHub in the .

Go to GitHub

Click Continue to GitHub.

Create the app

GitHub shows the name of the app: ferry-<your server>-<random>. Keep the name or change it. Click Create GitHub App.

Choose the repositories

GitHub asks where to install the app. Select All repositories or Only select repositories. Click Install.

GitHub sends you back to Ferry. Ferry shows the account as connected.

The repositories of an organization

Before you click Continue to GitHub, open Organization, self-hosted GitHub. Enter the login of the organization. Then Ferry creates the app in the organization. You must be an owner of the organization.

Change the repositories later

Use one of these buttons:

  • Repositories, next to the account in Server → Connections.
  • Change them on GitHub, below the repository list of a new service.

On this page