Google Drive

Creating the Destination

This guide shows how to add a Google Drive backup destination to JetBackup.

First make sure that you have the appropriate Google Drive destination plugin installed and enabled.

When creating the Destination, you will be prompted to install the Google Drive plugin and can click “Install Now” to install and enable the plugin.

Next, fill in the Backup Directory with the path you’d like to store your backups.

Then select the Google Drive Project (Integrated/Custom).

After selecting a Google Drive Project, click “Request Access Code” to authorize JetBackup to read and store files it creates using your Google Drive account. Proceed through the popup window until you receive an Access Code, which you can then paste in the “Request Access Code” text field.

An example of the Google App authorization popup after clicking “Request Access Code”. Please be sure to check the box “See, edit, create, and delete only the specific Google Drive files you use with this app” to allow JB the proper permissions:

Integrated

An example Integrated Google Drive Project Configuration page for the destination:

Custom

Follow these steps to setup your Custom Google Drive Project:

1. Navigate to https://console.developers.google.com/cloud-resource-manager and sign in with the Google Account you would like to create the custom project on.

Type in your project Name and then click the “CREATE” button

2. Enable Google Drive API for the project

Search for “Google Drive API”

Enable it for the project

3. Configure the OAuth Consent Screen

Click the drawer icon left to Google Cloud logo -> APIs & services -> OAuth Consent Screen to navigate to the Google Auth Platform page and then, press the “Get started” button. The consent screen must be configured prior to creating an OAuth Client ID for JetBackup.

Under “App Name” type the backup product’s name, such as “JetBackup”. Fill in the “User Support Email” field with your email address.

Select the Audience

Add your email in the Contact Information

Review Google API Services: User Data Policy and then press the “Create” button.

4. Configure the “Scopes” for your project. Scopes control what access your “App” has to your Google Drive. JetBackup will require read and write ability to be able to back up to your Google Drive.

Click the “Add or Remove Scopes” button

Now you should see a “Update Selected Scopes” panel on the right hand side. Please select the following scopes so you can add the Destination to JetBackup. The first two scopes are required to successfully authenticate when you use “Request Access Code” in a later step.

• ../auth/userinfo.email - View your email address
• openid - Associate you with your personal info on Google
• ../auth/documents - See, edit, create, and delete all of your Google Drive files
• ../auth/drive - See, edit, create, and delete all of your Google Drive files

The scopes ../auth/documents and ../auth/drive may not appear on the list and can be added in the “Manually add scopes” field.

https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/documents

5. Create OAuth client ID

Navigate to the Clients page on the left side bar and press “Create client”

Choose “Web Application” under the Application type dropdown menu and choose a name to identify the OAuth client such as “JetBackupOAuth”. Under Authorized redirect URIs, click on “+ ADD URI”, specify https://auth.jetbackup.com/google/ on the URI field then click the “Create” button.

The “OAuth client created” modal should appear. Save the Client ID and Client secret to use when adding the Custom Google Drive destination in JetBackup.

In JetBackup, fill in the OAuth 2.0 Client Id and OAuth 2.0 Client Secret fields with the Client ID and Client secret that was generated earlier.

An example Custom Google Drive Project Configuration page for the destination:

Destination Name

Specify a unique name for your destination. This will be used internally for your convenience.

Read Only

This option allows you to add the destination as a “Read Only” destination. You can only restore and download existing backups from a read-only destination. Read Only is required if the Backup Directory is already owned by another destination/server. This option is only selectable upon creating the destination and will be automatically enabled for any destinations added during a Disaster Recovery.

Owner

Specify the owner for this destination. This grants the owner and its parent account(s) permission to modify and delete this destination. Please note that the owner specified will also need Can Manage Destinations permission granted under the Permissions section.

Maximum Concurrent Threads

This option allows you to set the number of worker threads that can be used by the destination for upload/download/get/delete requests. This will be shared evenly across the number of Concurrent Tasks set for Backup or Restore/Download. As the tasks complete, the available threads will be allocated to the remaining active tasks up to the set limit. You can lower this value if you receive rate-limit errors from the remote destination.

Backup Directory

This will be our starting point when accessing this destination. Always use the absolute path and make sure to start with “/”. For example: /PATH/TO/FOLDER.

OAuth 2.0 Client Id (Custom Google Drive Project)

The unique identifier generated in the Google Cloud Console that identifies the application (JetBackup) requesting authorization to access Google Drive.

OAuth 2.0 Client Secret (Custom Google Drive Project)

The confidential key generated in the Google Cloud Console that is used to authenticate the application (JetBackup) when requesting authorization tokens from Google Drive.

Request Access Code

This option allows you to generate a secure access token for the purpose of storing and retrieving snapshots that were uploaded from your server using JetBackup.

HTTP Retries

Controls how many retries will be attempted if the destination returns an error for an HTTP call (upload / download / delete). [ default: 3 retries ]