Installation Guide

Cloudback provides secure, automated backups for your GitHub repositories. This guide will walk you through the process of setting up Cloudback for your GitHub account(s).

Overview of the Setup Process

To start backing up your repositories with Cloudback, you'll need to complete the following steps:

1. Choose a Plan:

   • Select a plan that covers the number of repositories you want to back up. This determines your backup capacity. You can find the full list of plans below.

2. Purchase a Plan:

   • Choose your preferred payment method and complete the purchase process.

   • Cloudback offers several payment options, including GitHub Marketplace, credit card, or bank transfer.

3. Install the Cloudback GitHub Application:

   • Grant Cloudback access to your repositories by installing our GitHub Application. This step is crucial for allowing Cloudback to read and backup your repository data.

4. Verify configuration:

   • While Cloudback works out of the box with default configuration, you can customize various aspects of your backup process if required.

Now, let's go through each step in detail:

1. Choose Your Plan

Cloudback offers several plans to suit your backup needs. Choose the plan that best fits the number of repositories you want to protect. Here are the available options:

• Free Plan:

  • Backup one repository to the cloud

  • Price: $0

• Per 10 repositories monthly plan:

  • Price: $10 per 10 repositories/month

  • Free trial available

• Per 100 repositories monthly plan:

  • Price: $75 per 100 repositories/month

  • Free trial available

• Per 1000 repositories monthly plan:

  • Price: $500 per 1000 repositories/month

  • Free trial available

You can purchase multiple units of each plan to increase coverage. For example, buy 2 units of the 10-repository plan to cover 20 repositories.

Cloudback offers fair pricing based on the number of repositories, not team size. This applies to both personal and organization accounts.

Cloudback allows you to protect multiple GitHub accounts with a single plan. This feature is useful for those who manage several GitHub accounts. For example, you can use a single 100-repository plan to cover three separate accounts with 20, 30, and 50 repositories respectively. To utilize this option, simply contact our support team at [e-mail] with the list of accounts you wish to cover under a single plan.

2. Purchase a Plan

You can purchase a Cloudback plan using one of the methods below. If you have any questions or need assistance, please don't hesitate to contact our support team. For more information on payment methods, see Payment Methods.

GitHub Marketplace Payments

• Select your preferred plan on the Cloudback page on the GitHub Marketplace.
• Follow GitHub instructions to complete the purchase.

• Cloudback will automatically activate for the selected account.

Azure Marketplace Payments

• Select your preferred plan on the Cloudback page on the Azure Marketplace.
• Follow Azure instructions to complete the purchase.

• Purchased plans will be activated automatically.

Credit Card Payments

• Credit card payments are processed through Paddle.

  • It may be a subject to additional fees. Please refer to the Paddle website for more information.
• To start the process, contact our support team at [e-mail].
• Our team will guide you through the purchase process.

Bank Transfer Payments

• Bank transfer payments are available starting from quarterly plans.

• To start the process, contact our support team at [e-mail].
• Our team will guide you through the purchase process.

Coupa Supplier Portal

Coupa’s Supplier Portal connects purchasing organizations with suppliers, providing tools to get paid faster and get more accounts.

• To start the process, visit our supplier's page on Coupa Supplier Portal.
• Contact our support team at [e-mail].
• Our team will guide you through the purchase process.

3. Install the Cloudback Application

Initial Installation

Note: If you purchased a plan through the GitHub Marketplace, the Cloudback Application is already installed, so you can skip this step.

To start backing up your repositories, you'll need to install the Cloudback Application for each GitHub account you wish to protect. Follow these steps:

1. Visit the Cloudback Dashboard.
2. Sign in with your GitHub account.

   • Authorize Cloudback to access your GitHub account when prompted.

3. Review and accept the Terms of Service and Privacy Policy.

4. Click the "Install" button on the dashboard to install the Cloudback Application on your GitHub account. During installation, you will be prompted to grant repository access. You have two options:

   • Grant access to all repositories (recommended for convenience).

   • Select specific repositories to grant access to.

Managing GitHub Installations

You can manage your GitHub installations at any time from the Cloudback Dashboard:

1. Click on your profile icon in the top-right corner.

2. Select "Manage GitHub Installations" from the dropdown menu.

   • Alternatively, you can directly access the Manage GitHub Installations page.

Note for Free Plan Users: Even if you grant access to all repositories, you will only be able to back up one repository under the free plan.

Things to Consider

• Separate Installations for Multiple Accounts: Install the Cloudback Application separately for each GitHub account you wish to protect.

• Multi-Account Protection: To protect multiple accounts under a single plan, please contact our support team. Remember, you still need to install the app on each account individually.

• Security and Permissions:

  • Cloudback uses the official GitHub API and is a GitHub-verified application.

  • We only request the read-only permissions necessary for operation.

• Installation vs. Plan Coverage: Installing the application grants Cloudback access to your repositories based on the permissions you set. However, your chosen plan determines how many repositories you can actually back up.

4. Verify Configuration

After installation, you'll be redirected to the Cloudback Dashboard, where you can verify and adjust your configuration settings:

• Automatic daily backups are enabled for the number of repositories covered by your selected plan. All new repositories will be automatically backed up if they are within the plan limit. You can configure the repository name pattern to choose the new repositories you want to back up automatically. Other account settings can be adjusted in the Account Settings page.
• Cloudback uses Cloudback Managed Storage, but you can configure your own storage option if required.

• The backup schedule is set to daily, but you can configure your preferred frequency.

• The retention policy is set to 30 days, but you can adjust this as needed.

• There are daily notifications of failed backups, if any occurred. You can also enable instant notifications for backup status and errors, or change email address for email notifications.

• You can always modify your settings later through the Cloudback Dashboard.

Setup Complete

Congratulations! Cloudback has been successfully installed and configured for your GitHub repositories. Here's what you can expect next:

• Backup Schedule: Your first backups will commence according to the schedule you've set.

• Dashboard Access: Access your Cloudback Dashboard anytime at https://app.cloudback.it using your GitHub account.
• Service Status: If you experience any issues accessing the website, please check our status page at https://status.cloudback.it/ for updates on maintenance or service interruptions.
• Support: If you have any questions or need assistance, don't hesitate to contact our support team.

Learn More

To get the most out of Cloudback, explore these resources:

• Automated Daily Backups
• On-Demand Manual Backups
• Storage Configuration
• Metadata Backups

Need help? Contact our support team.