Last modified: August 28, 2019

Overview

This document explains how to set up your Google Drive™ account as an Additional Destination in WHM’s Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration).

Set up the Google Drive API for your Google account

To configure the Google Drive API for your Google account, perform the following steps:

1. Visit the Google API Manager website.
2. In the left navigation bar, click Library.
3. Under the G Suite heading, click Google Drive API.
4. Click Create Project, and then click Create. A new menu will appear.
   Note:

   If the new menu does not appear, perform the following steps:

   1. Click Credentials in the left navigation bar.
   2. Click Create.
      
5. Enter your new project name and click Create.
6. Click Enable.

Increase your Google API quota

According to Google’s documentation, Google imposes limits and quotas on their APIs. This can cause errors when you back up your server to Google Drive.

To avoid errors due to these limitations, we recommend that you perform the following steps to increase your default quota settings:

1. Visit the Google API Manager website.
2. In the left side navigation bar, click Google Drive API.
3. Click Quotas.
4. Increase the value of the Queries per 100 seconds per user setting.
   Note:

   A maximum value of 1000 usually resolves these errors. However, a lower setting may sufficiently resolve most errors.

5. Click Done.

Create your account credentials

To set up Google Drive account credentials for backups, perform the following steps:

1. Visit the Google API Manager website.
2. In the left side navigation bar, click Credentials.
3. Click Create credentials.
   Note:

   If you already possess Google Drive account credentials, click Create credentials and click Help me choose.

4. From the Which API are you using? menu, select Google Drive API.
5. From the Where will you be calling the API from? menu, select Web Server (e.g. node, js, Tomcat).
6. From the What data will you be accessing? menu, select User Data.
7. Click What credentials do I need?.
8. In the Create an OAuth 2.0 client ID. text box, enter your desired name.
9. In the Authorized redirect URIs text box, enter the https://hostname:2087/googledriveauth/callback link, where hostname represents your server’s hostname.
   Note:

   To locate your server's hostname, perform either of the following actions:

   • Run the `hostname` command as the `root` user.
   • Navigate to WHM's Change Hostname interface (WHM >> Home >> Networking Setup >> Change Hostname). The server's hostname appears under the Current Hostname heading.

10. Click Create. The interface will display your new client ID and client secret.
    • We strongly recommend that you save these credentials in a secure location. Step 7 of the Create a Google Drive transport procedure requires these credentials.
    • You can also download a JSON file with your client ID and client secret, or access them in the Credentials section.
11. Click Done.

Create a Google Drive transport

To create a Google Drive transport, perform the following steps:

1. Log in to WHM as a root-enabled user.
2. Navigate to WHM’s Backup Configuration interface (WHM >> Home >> Backup >> Backup Configuration) and scroll to the Additional Destinations section.
3. From the Destination Type menu, select Google Drive™.
4. Click Create new destination.
5. Enter your desired destination name.
6. Enter the desired folder in which to store backups.
   Note:

   If you do not specify a folder, the system will store backups in the top-level folder.

7. Enter your client ID and client secret.
8. Click Generate Credentials to create the credentials file. A new tab will appear that allows you to authorize access to your Google Drive data.
9. Click Authorize Access.
10. In the Timeout text box, enter the desired timeout duration.
11. Click Save Destination.
    Notes:

    • To validate your remote destination, click Save and Validate Destination.
    • If you do not authorize access to your Google Drive data, this action will fail.