Back to FAQ

How do I install BackHub?

1. Choose a plan on GitHub Marketplace

In order to install BackHub, please head over to GitHub Marketplace, click on “Set up a plan” and choose a plan that suits your needs.

Set up a plan on GitHub Marketplace

You can try all our plans free for 14 days.

Choose a plan

Choose a plan that suits your needs. BackHub creates backups of all repositories in your account by default but you can also choose to backup only select repositories.

Next, you will see a summary of your order. Under “Billing information” you can choose the billing account for which you want to install BackHub and start creating backups. If everything is correct, click on “Complete order and begin installation”.

Choose account

2. Install BackHub

In the next step, you will be able to manage repository access. BackHub creates backups for all repositories you give access to. That means if you grant access to “All repositories” backups for all current and future repositories will be created automatically. In case you want to backup only select repositories, please choose “Only select repositories” and type in the names of the repositories you want to backup.

Set access to GitHub repositories

Secondly, you will see the permissions BackHub is asking for. In order to create backups, read access to code is necessary. For backing up the metadata and to manage access to backups read access to administration, issues, members, metadata, pull requests, and repository projects are needed.

Click on “Install” to start installation. GitHub might ask you for your password in order to confirm the installation.

Start installation

3. Sign in to BackHub

After the installation of BackHub for your account has been completed, you will be asked to verify your identity on GitHub with your personal GitHub user. This is to be able to login on backhub.co and manage your installations.

Click on “Authorize backhub” and you will be redirected to backhub.co.

Authorize BackHub and verify your identity on GitHub

4. Create Backups

On backhub.co you will see an initial dialog with the number of repositories you gave access to and the account for which you have installed BackHub.

In order to start creating backups for your GitHub repositories, click on “Create backups”.

Create backups

Next, you will see a list of all backups with either a grey and the status “… pending” or already “… in progress” with a yellow border. Depending on the size and amount of your repositories, creating the backups can take between a couple of minutes or up to a few hours.

Pending backups

Once the backups is successfully created, it will have a green border and a timestamp when the backup was created. Come back later to this page if you want to check the status of your backups.

Example of a successful GitHub repository backup