ConceptsServices
A git repository
Ferry clones the repository, checks out the branch and builds the code.
Ferry clones the repository and checks out the branch.
1 / 3
Create a service from a repository
ferry create api --repo https://github.com/you/api --branch main--repo is the URL of the repository. The default branch is main.
Which commit Ferry builds
A deploy builds the newest commit of the branch. To build an exact commit, give its SHA.
ferry deploy api --commit <sha>Auto-deploy
Auto-deploy is on by default. If you set up the GitHub webhook, a push to the branch deploys the service. To turn it off, use --no-auto-deploy.
Ferry accepts these forms:
https://,ssh://andgit://URLs.- The scp form:
git@github.com:you/api.git. file:///path.- The absolute path of a repository on the server.
With ferry create, a relative path that exists on your machine becomes an absolute path.
- Connect your GitHub or GitLab account to the server. You authorize it on the page of the provider. Then Ferry clones the repositories of the account, for each service.
- Or put a token in an HTTPS URL:
https://user:token@github.com/you/api. Ferry never prints the token in logs or errors. - SSH URLs use the SSH keys of the user that runs
ferryd, in batch mode. Ferry accepts new host keys and refuses changed host keys.
Ferry does not fetch git submodules.