Back to FAQ

How do I install BackHub?


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

To choose a plan:

  1. Open GitHub Marketplace
  2. Click "Set up a new plan".
  3. Choose a plan that suits your needs. Set up a plan on GitHub Marketplace Choose a plan

    By default BackHub creates backups of all repositories in your account but you can also choose to backup only select repositories.

Next, you will see a summary of your order.

To start installing BackHub:

  1. Under "Billing information" choose the billing account for which you want to install BackHub and start creating backups.
  2. When everything is correct, click "Complete order and begin installation".

    Choose account

    Next you will manage repository access and permissions.

    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.

  3. Grant access and permissions as appropriate.

    Set access to GitHub repositories
  4. Click "Install" to start installation.

    GitHub may ask for your password to confirm the installation.

    Start installation

To sign into BackHub:

After the installation of BackHub for your account is complete, you verify your identity on GitHub with your personal GitHub user. This allows for login on backhub.co and management of your installations.

  1. Click on "Authorize backhub".

    You are redirected to backhub.co.

    Authorize BackHub and verify your identity on GitHub

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".

    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.

    Pending backups

    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.

    Example of a successful GitHub repository backup