Administrator Guide

Overview

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

The overall process requires 7 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: Enabling your Google Drive API

  1. Log in to the Google Developers Console.
     
  2. Click on Select a project.



  3. In the dialog box that appears, click the + button to create a new project.



  4. Give your New Project a suitable name.

     

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

Step 1: Enabling your Google Drive API

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


  2. Then, click Enable.

     

Step 2: Enabling your Google Picker API

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



  2. Then, click Enable.


Step 3: Creating a Client ID

  1. Log in to the Google Developers Console.

  2. Go to the Hamburger Icon > API Manager.
     
  3. Click on Credentials.
     
  4. Click Add credentials > OAuth client ID


     

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



  5. You will see an error message stating, "To create an OAuth Client ID, you must first set a product name on the consent screen."



    Click Configure consent screen to set a product name on the consent screen.

  6. Enter a Product name shown to users.



    You can fill in the other fields if you want, but only the Product name is required.
    Click Save when you're done.

  7. You are now on the Create client ID page.
    Under Application Type, choose Web application.
     
  8. Under Authorized JavaScript Origins, set your Confluence URL.
     

  9. 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 a Error 400 being thrown back from Google. Refer here for further information on this.

  10. You should have something that looks like this:



    When you're done, click Create.

  11. 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 4: Creating 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 5: Configuring 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 6: 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 7: Verifying 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?