The application's System Configuration page allows you to set up custom OAuth2 helpers for each of the following storage providers. The process is two-fold. Here is an overview of the steps:
-
Creating a custom OAuth2 helper (you only need to do this once).
-
Create an API application on the storage provider
-
Get your Client ID and Secret
-
Paste them into Akeeba Backup's component configuration
-
-
Setting up Akeeba Backup to use the OAuth2 helper (you need to do this on every Akeeba Backup installation, and backup profile, which will be using this remote storage provider).
-
Change the OAuth2 Helper setting to Custom in your backup profile configuration
-
Paste in your OAuth2 Helper URL and OAuth2 Refresh URL
-
Save
-
Click on the Authentication - Start Here
-
Copy your new access and refresh tokens to your backup profile configuration
-
Save & Close
-
Please note that the instructions for creating an API application are for illustrative purposes only. We are not in control of third party services and we cannot guarantee that we will update our documentation to reflect changes in the third party services' interfaces.
![[Note]](/media/com_docimport/admonition/note.png) | Note |
|---|---|
|
For use with the Upload to Box.com post-processing engine. |
| Note |
|---|---|
|
This needs to only be done once, on the site which you will be using to host the OAuth2 helpers. It may be the same, or a different site than the one you are going to use the helpers on. |
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 Box.com 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=box
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
| Note |
|---|---|
|
This section is for illustrative purposes only. We are not in control of third party services, and we cannot guarantee that we will update our documentation to reflect changes in the third party services' interfaces. |
Go to https://developer.box.com/ and click on .
Click on .
Select Custom App.
Enter an App Name and Description of your choice. In the Purpose field choose Automation, and in the "Who is building this application?" field choose Customer.
Click on Next.
Select User Authentication (OAuth 2.0).
Click on .
You are taken to your application's Configuration page.
![[Tip]](/media/com_docimport/admonition/tip.png) | Tip |
|---|---|
|
If you got lost / closed the tab, don't despair! You can find your way back here from the main Box Developer site, My Apps, click on your app's name, then click on Configuration. |
Scroll down to the OAuth 2.0 Redirect URI and paste in the Callback URL you copied from your site.
Under Application Scopes select the following items:
-
Read all files and folders stored in Box
-
Write all files and folders stored in Box
Click on .
Find the OAuth 2.0 Credentials section.
There are two fields: Client ID and Client Secret. Copy them. You will need them in the next step.
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 Box.com 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 Box.com" section.
Click on .
| Note |
|---|---|
|
This needs to be done on every Akeeba Backup installation and backup profile which will be using this custom OAuth2 helper. The site using the OAuth2 helper does not necessarily have to be the same site you have set up the OAuth2 helper on. |
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 Box.com. 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 Box.com
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.
| Tip |
|---|---|
|
You will know you are doing it right if the popup displays a warning letting you know what you are about to link it with an application which is not under the control of Akeeba Ltd. If you see the Box.com interface, you missed the previous step (clicking on Save); in this case close the popup, click on Save, and then click on Authentication - Start here again. |
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.