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.
You can try all our plans free for 14 days.
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 wich you want to install BackHub and start creating backups. If everything is correct, click on “Complete order and begin installation”.
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.
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.
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.
On backhub.co you will see an initial dialog with the number of repositories you gave access to and the account for wich you have installed BackHub.
In order to start creating backups for your GitHub repositories, click on “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.
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.
Yes, it’s possible to have BackHub create backups for new repositories in your GitHub account automatically.
BackHub creates backups of all repositories it gets access to. If you have set up access to “All repositories” this applies to all current and future repositories. Hence, a backup for new repositories is created automatically.
If you have set up access to “Only select repositories” then you need to manually add the name of the repository in order to create a backup for it.
If you want to add a repository for backup creation or change the overall setting, please open the user menu on the top right of the BackHub UI and choose “configure access” or manage settings for your BackHub installations directly from your GitHub account.
Yes, it’s possible to only backup select repositories.
BackHub creates backups of all repositories it gets access to by default. If you want to backup only select repositories you can simply limit access to those repositories you want to backup.
In the installation dialog you are being asked to choose whether you want to give access to all or only select repositories. Please choose “select repositories” and type in the names of the repositories you want to backup.
If you have already installed BackHub, you can edit the permissions by managing your installations on GitHub.
Yes, you can use BackHub to archive your GitHub repositories. Once a backup is complete, you can delete the original repository in GitHub. Since the upstream for creating further backups from the original repository will no longer be available, the backup is being archived automatically and listed in a separate section in the bottom of the page. You can restore the repository back to GitHub from an archived backup anytime.
Please note that not all data can be restored to GitHub directly and might come in a different format. You can learn more about what you can restore here.
A backup can only be deleted when it has been archived. A backup is being archived automatically when BackHub can’t access the original repository at GitHub any longer. That happens either when access is being revoked for the installation, for this specific repository or if the original repository has been deleted on GitHub. Archived backups are listed in a separate section in the bottom of the page and are indicated by a dashed outline.
You will find the delete button in the footer section of the backup panel. When you delete a backups it’s being removed permanently and can’t be restored any longer.
BackHub is creating daily snapshots and keeps snapshots of the last 30 days.
We can’t keep snapshots older than that for compliance with our GitHub partner agreement. If you want to keep an older version of your backup we recommend downloading the data from BackHub and keeping an offline copy of it.
Please note that once a backup looses connection to it’s original repository (e.g. when the repository is being deleted or the access token revoked), snapshots age out and after 30 days all snapshots will contain the same data.
Backups are being updated on a daily basis.
You can find the timestamp of the latest complete backup of your GitHub repository when you open the panel of a backup.
We also create daily snapshots of each backup up to 30 days back in time.
When a backup fails, automatic retries are made until the backup is successful. If the backup continues to fail, our technical support is being notified. A failing backup is indicated in the user interface with an error message in the backup panel and a red border.
When you delete a repository at GitHub, the backup of that repository can't be updated any longer and is therefore being archived.
Archived backups are listed in a separate section in the bottom of the page and are indicated by a dashed outline.
The backup includes the complete git repository plus GitHub related metadata associated with the repository like issues, milestones and more.
We are including most data available via the GitHub API associated with the repository. This currently includes:
|Pull Requests||Pull requests are included in the backup but can only be restored as issues due to limitations of the GitHub API|
|Wiki||Can't be restored automatically due to limitations of the GitHub API.|
In order to create backups for your organization, you need to install BackHub on your GitHub organization account. Please follow the steps in the installation guide and make sure to choose your organization as the billing account.
Yes, archived backups count against your quota. We recommend downloading the repository and metadata for long term storage of repositories you don’t work on any longer. Please keep in mind though that restoring back to GitHub is only possible for backups inside BackHub.
Payments and billing schedule are governed by the GitHub Marketplace Terms of Service.
Marketplace purchases are billed in advance on a monthly or yearly basis respectively and are non-refundable. There will be no refunds or credits for partial months of service, downgrade refunds, or refunds for months unused; however, the service will remain active for the length of the paid billing period.
Your payment schedule is determined by the payment schedule you chose for your GitHub account. You are automatically billed annually for our service when you choose annual billing for your GitHub account. Please refer to the GitHub Marketplace Terms of Service for further details.
Yes, you can download the repository of any backup or snapshot of a backup directly from BackHub.
Please open the panel of a backup, click “download repository” and choose “current” for the latest backup or any of the snapshots available. The download contains the complete repository including the git history and all it’s branches.
Yes, you can download the metadata of any backup or snapshot of a backup directly from BackHub.
Please open the panel of a backup, click "download metadata" and choose "current" for the latest backup or any of the snapshots available. The download contains all available metadata in JSON format.
In order to restore a backup, please open the panel of the backup you want to restore, click the restore button and select the snapshot you want to restore. A restore dialog will open in a modal.
In order to restore, BackHub will create a new repository in your GitHub account and restore the data via the GitHub API into this newly created repository. In the restore dialog please type in a name that is different from the original repository or any other repository in your account.
You can choose whether you want your repository to be private or public.
Restoring your repository back to GitHub may take a while depending on the size of your repository and the associated metadata. Usually it takes not more than 5 minutes. Please do not change anything in the newly created repository until the restore process is complete.
You can choose an earlier version of your backup from the popup menu when clicking the restore button. Please follow the instructions on how to restore a repository.
Our service works with GitHub OAuth and is dependent on the GitHub API. That is why it is not possible at this point to restore or access your backups in case GitHub is not available. You can check the GitHub API status over here.
Because wikis are just Git repositories, you can make changes locally and push them to your repository using a Git workflow.
First, download the wiki of your backup. Please open the panel of a backup, click “download wiki” and choose “current” for the latest backup or any of the snapshots available. The download contains the complete wiki repository.
Next, clone the empty wiki of the repository you want to restore into, following the instructions on the GitHub documentation.
Now that you have a local copy of your empty wiki and a local copy from the wiki of your backup, you can simply copy the files from the backup over into the empty wiki and commit them.
You can restore everything that is included in the backup. However, due to limitations of the GitHub API, some data can't be restored directly or comes in a different format for practical reasons:
If you want to change your plan, please head over to GitHub Marketplace click “Edit your plan” and choose the account’s plan you want to change.
In the “Edit your plan” dialog you will find a select box where you can choose another plan. Please select a plan that suits your needs and click on “Issue plan changes”.
Please note that in case you have more backups in your account than your plan allows, backups that exceed the quota will be deactivated.
If you want to cancel your account, first you need to cancel your plan on GitHub Marketplace.
Please head over to GitHub Marketplace, click “Edit your plan” and choose the account’s plan you want to cancel.
In the “Edit your plan” dialog, you will find a link “Cancel this plan” in the bottom of the box where you can choose a plan.
When you cancel a plan, it stays active until the end of the current billing cycle. When your plan has expired, any existing backup in your account is being deleted.
Next, you need to uninstall the BackHub GitHub app.
When you uninstall the BackHub GitHub app, any existing backup in your account is being deleted after 24 hrs.
In case you don’t have any other BackHub installations, you can also revoke access for your personal GitHub user, wich has been necessary to manage BackHub installations. Head over to the settings of your GitHub user and click “Revoke” for BackHub.
Existing backups in BackHub basic can’t be transferred to BackHub on GitHub Marketplace.
For active backups you can simply create a new account with BackHub on GitHub Marketplace and cancel the old one in BackHub basic.
Inactive or archived backups of repositories wich do not exist in your GitHub account must be restored first in order to create a backup for it in BackHub on GitHub Marketplace or downloaded for archiving purposes.
You can also keep the archived backups in BackHub basic with an ongoing account. However, we recommend using BackHub on GitHub Marketplace for various reasons.
“Old account” is referring to all accounts created before the launch of BackHub on GitHub Marketplace on December 5th 2017. We refer to those as BackHub basic because it’s an independently operating service built on a separate infrastructure.
You can login to your account following this link. You can also find a login link in the footer of our homepage.