The Greenhouse Developer Hub

Welcome to the Greenhouse Developer Hub. You'll find comprehensive guides and documentation to help you start working with Greenhouse as quickly as possible, as well as support if you get stuck. Let's jump right in!

Documentation      Community Forum

Specifying Git repository

This tutorial will help you add your Git repository to Greenhouse.

Clicking the add new app card on the dashboard will open a new project creation flow that asks for your Git repository URL and authentication type for the repository.

In the example below, I have entered our dummy Android app's GitHub URL and selected public authentication:

Adding a public Git repository.

Adding a public Git repository.

For authentication you have three options:

Public authentication

If you have a public repository stored in GitHub, Bitbucket or any other Git server, you should select Public repository for the authentication type. Please note, however, that you have to use http(s):// URL for the repository.

So, for GitHub users, the repo URL should be in the form

https://github.com/username/repository-name.git

For Bitbucket users, the repo URL should look like

https://user@bitbucket.org/username/repository-name.git

and for GitLab users, the URL should be in the form

https://gitlab.com/username/repository-name.git

After filling in the repository field, hit the green continue button. Greenhouse will then fetch the branches from your repository and you will be directed to the build configuration section.

Username and password authentication

In case you have a password protected repository, or in other words you are using basic auth to protect your Git repository, you should select Username and password for the authentication type. Having done so, two more inputs are displayed so that you could fill in your credentials.

As with public repos, we expect you to enter your repository URL in http(s):// format, otherwise you might see a warning that asks you to do so anyway. In conclusion, if your repository is in GitHub, the repo URL should be in the form

https://github.com/username/repository-name.git

For Bitbucket users, the repo URL should look like

https://user@bitbucket.org/username/repository-name.git

and forit GitLab users, the URL should be in the form

https://gitlab.com/username/repository-name.git

All others just make sure your URL starts with a http(s):// prefix.

Adding a password protected Git repository.

Adding a password protected Git repository.

After you have filled in the repository and credentials inputs, you can hit the green "continue" button which will trigger Greenhouse to fetch branches from your repository and will get you to build configuration section.

SSH key authentication

Your repository is protected by an SSH key? No worries, just select SSH Key from the authentication dropdown. You will be displayed an input where you can drag-n-drop your SSH private key or on which you can click to pick the key in a more conventional way. At the very moment you select or drop the key, we will peek into it and check if it's password protected. If we discover that the key is indeed protected, we kindly ask you to write the passphrase to the input field that appears under the SSH key field.

Please note that in case of SSH key authentication, you should provide a repository URL that starts with ssh://, so the given URL should be something of the form

ssh://username@example.com/path/to/repo

If you are self-hosting your Git repository, you probably know very well what you are doing already :) If you are using a cloud-based provider, the exact pattern of the URL will vary from one hosting service to another:

For example, GitHub users will use a URL that has the following pattern:

git@github.com:username/repo-name.git

and for Bitbucket users the repo URL should look like

git@bitbucket.org:username/repo-name.git

In case you host your repository in GitLab, the URL is of the form

git@gitlab.com:username/repo-name.git
Adding a SSH key protected Git repository.

Adding a SSH key protected Git repository.

After you have filled in the repository field and have selected the SSH private key, you can hit the green "continue" button. Greenhouse will then fetch the branches from your repository and you will be directed to the build configuration section.

Specifying Git repository

This tutorial will help you add your Git repository to Greenhouse.