1. Help Center
  2. Getting started

How to install BackHub

Installing BackHub from GitHub Marketplace.

These are the instructions to install BackHub with a plan from GitHub Marketplace. If you want to purchase an enterprise plan, see instructions here.

Before installing you first choose a plan. You can try all our plans free for 14 days. 

To purchase a plan:

1. Open GitHub Marketplace

2. Click "Set up a free trial".

3. Choose a plan with the size that suits your needs. If you need plans larger than 1200 repositories, please contact sales. 

The summary of your order displays.

4. Under "Billing information" choose the account for which you want to create backups.

Note: You need a separate plan and installation for your personal account and each organization. 

5. When everything is correct, click "Complete order and begin installation".

To install BackHub:

Next you manage repository access and permissions. 

1. Grant access and permissions as appropriate.

Access. BackHub creates backups for all repositories you grant access to. If you grant access to "All repositories" then backups for all current and future repositories will be automatically created. If you want to backup only select repositories, choose "Only select repositories" and enter the names of the repositories you want to backup.

Permissions. BackHub requires read access to code. For backing up the metadata and to manage access to backups, read access to administration, issues, members, metadata, pull requests, and repository projects is also required.

2. Click "Install" to install BackHub. (GitHub may ask for your password to confirm the installation)

To sign into BackHub:

1. Click on "Authorize backhub". 

You are redirected to backhub.co.

To create backups for your GitHub repositories:

On backhub.co an initial dialog displays with the number of repositories you granted access to, and the account for which you have installed BackHub.

1. To start creating backups, click "Create backups".

A list of all backups displays. Backups are marked either in grey with the status "… pending" or already "… in progress" with a yellow border. Depending on the size and number of your repositories, creating the backups can take between a couple of minutes or up to a few hours.

Once the backups are successfully created, a timestamp with a green border displays.

2. Return to this page later if you want to check the status of your backups.