FerryDocs

Private repositories

Ferry needs read access to clone a private repository. There are three ways to give it.

Edit on GitHub
Accountconnected to FerryTokenin the HTTPS URLSSH keyof the ferryd userFerry clonesPrivate repo

A connected account

Connect your GitHub account to the server. You authorize it on a page of GitHub. This makes a .

Then Ferry the repositories of the account with the account. This applies to each method that creates a service. The URL has no credentials.

HTTPS with a token

Put a GitHub personal in the URL. The token needs read access to the contents of the .

Repository URL
https://USERNAME:TOKEN@github.com/you/api

Ferry keeps the credentials out of the build logs and the error messages. It gives them to git through the environment, not through the command line.

SSH

Use the SSH URL. Give the user that runs ferryd an SSH key that GitHub accepts, for example a deploy key.

Repository URL
git@github.com:you/api.git

Git runs in batch mode. It accepts the host key at the first connection.

On this page