Support

Getting the Callback URL

Log into the backend of the site you want to host the OAuth2 helpers.

If you're on WordPress: go to Akeeba Backup.

Click on System Configuration.

Click on the OAuth2 Helpers tab.

Set OAuth2 Helper for Google Drive to Yes. You will see a blue note with three URLs below. Copy the Callback URL. It looks something like this (line breaks added for clarity):

https://www.example.com/index.php?view=oauth2&task=step2&format=raw&engine=googledrive

Copy this URL. Please remember that you need to use this URL verbatim in a later step.

Click on the Close button, without saving the component options.

Creating the API application

Log into the Google Cloud Console.

Click the top drop-down (project selection) and click on New Project.

Give it a name and click on Create.

Make sure the application is selected in the drop-down at the top. If not, do it now.

Click on the hamburger menu icon on the top left. Click on APIs & Services, Library.

Look for Google Drive API and click on the item by that name.

Click on Enable.

Click on the hamburger menu icon on the top left. Click on APIs & Services, OAuth Consent Screen.

Choose External. Click on Create.

Fill in all the required fields. In the Authorized domains section click on Add Domain and enter the domain of the site where the custom OAuth2 helper will be hosted.

Click on Save and Continue.

Click on Add or Remove Scopes.

Look for auth/drive and select (check) the scope which appears as .../auth/drive, then click on Update. You should now see it under "Your restricted scopes".

Click on Save and Continue.

Optional. Click on Add Users to add the Google Account email addresses of everyone who will be allowed to use this API application to link their Akeeba Backup installations with Google Drive. Otherwise, only you (the account which created this API app) will be able to log in.

Click on Save and Continue.

Click on the hamburger menu icon on the top left. Click on APIs & Services, Credentials.

Click on Create Credentials, then click on OAuth Client ID.

Select Web application in the drop-down.

Find Authorized redirect URIs and click on Add URI under it.

Paste the Callback URL you copied earlier.

Click on Create.

Copy the Client ID and Client Secret displayed to you.

Enabling the custom OAuth2 Helper

Log into the backend of the site you want to host the OAuth2 helpers.

If you're on WordPress: go to Akeeba Backup.

Click on System Configuration.

Click on the OAuth2 Helpers tab.

Set OAuth2 Helper for Google Drive to Yes.

Paste the Client ID and Client Secret you copied in the previous step into the same-named text boxes under the "OAuth2 Helper for Google Drive" section.

Click on Save & Close.

Getting the OAuth2 Helper and Refresh URLs

Log into the backend of the site which hosts the OAuth2 helpers.

If you're on WordPress: go to Akeeba Backup.

Click on System Configuration.

Click on the OAuth2 Helpers tab.

Find the OAuth2 Helper for Google Drive. You will see a blue note with three URLs below.

Copy the OAuth2 Helper URL and OAuth2 Refresh URL.

Telling Akeeba Backup to use a custom helper

Log into the backend of the site you will be taking the backups on. This may be different than the site which hosts the OAuth2 helpers.

If you're on WordPress: go to Akeeba Backup.

Select your backup profile, and click on Configuration.

Scroll down to the Post-processing Engine.

Select Upload to Google Drive

Change the OAuth2 Helper to Custom.

Paste the OAuth2 Helper URL and OAuth2 Refresh URL you copied in the previous step.

Click on Save. This is important! Until you click on Save, Akeeba Backup does not know you intend to use a custom OAuth2 Helper.

Authentication and setup

When the page reloads, click on Authentication - Start here.

Go through the authentication.

At the end, you will see an Access Token and a Refresh Token. Copy them into the respective fields of your Akeeba Backup profile.