Administrator Guide

This guide walks Confluence administrators through the process of setting up the Connector for Google Drive and Confluence.

The overall process requires 8 major steps, which are outlined below.

Disclaimer

Google frequently updates the Developer Console interface. The instructions and screenshots on this page may differ slightly to what you may be able to see.


Step 1: Create a new project

  1. Log in to the Google Developers Console.
     
  2. Go to the organization pull down menu in the top bar and click on it.



  3. In the dialog box that appears, click New Project.



  4. Give your New Project a suitable name.

     

    Click Create.
     
  5. You will be taken to the Dashboard.

Step 2: Enable your Google Drive API

  1. On the Dashboard, in the sidebar, go to APIs & Services > Library.



  2. In the API Library, look for and click on Google Drive API.



  3. Then, click Enable.

     

Step 3: Enable your Google Picker API

  1. In the API Library, search for Google Picker API.



  2. Then, click Enable.


Step 4: Create a Client ID

  1. Go to the Hamburger Icon > API & Services > Credentials.


     
  2. On the Credentials screen, click OAuth consent screen.



  3. Enter an Application name.



    You can fill in the other fields if you want, but only the Application name is required.

    Take note that Google restricts certain words from being used as a product name, e.g. "Google".

    Click Save when you're done.

  4. You are now back on the Credentials screen.
    Click Create credentials > Oauth client ID.



  5. Under Application Type, choose Web application.


  6. The screen should now expand to show several more options.
    Let's start by giving a name.
    In the screenshot example below, we enter "Confluence".



  7. Under Authorized JavaScript Origins, set your Confluence URL.
     

  8. Under Authorized Redirect URIs, set the following line:

    <Confluence URL>/users/plugins/cwgoogledrive/callback.action

    Domain vs IP Addresses

    If you are using a private IP for your Confluence instance, set up a domain name for it; as using an IP will result in Google giving you an Error 400. Refer here for further information on this.

  9. You should have something that looks like this:



    When you're done, click Create.

  10. A window will pop up with your Client ID and Client Secret. Copy these down.
     
Please take note of the usage of http and https in your Confluence URL, it has to be configured accurately in Google API settings.

Step 5: Create an API Key

  1. On the same Credentials screen, click Create Credentials > API Key.

     

  2. In the dialog window that pops up, choose Browser key.

     

  3.  Enter a suitable name, then click Create.

     

  4.  The API Key will be created and you will be able to copy it.

Step 6: Configure Confluence with the Client ID, Client Secret, and API Key

  1. Go to your Google Drive Settings in Confluence.
    • Go to the Cog Icon  > Add-ons.
    • In the sidebar, under Google Drive Configuration, click Google Credentials.
       
  2. Enter the Client ID, Client Secret, and API Key into the matching fields.



  3. Click Save.

Step 7: Add Google to the Confluence Whitelist

This step is particularly recommended for users on Confluence 6.

  1. Go to the Cog Icon  > General configuration.

  2. In the sidebar, under Users & Security, choose Whitelist.

  3. Now enter the following:
    1. Expression:https://*google.com
    2. Type:Wildcard expression
    3. Allow Incoming:True

  4. You should have something that looks like this:



    Click Add

Step 8: Verify App on Google

Google has recently implemented a new security feature to protect user's data. The security feature will now require developers to send in a Verification Form to Google to verify the Application.

For more information on the impact of this feature, please check out this Knowledge Base.

What's Next?