Note: You are currently viewing documentation for Moodle 2.6. Up-to-date documentation for the latest stable version of Moodle may be available here: Google OAuth 2.0 setup.

Google OAuth 2.0 setup: Difference between revisions

From MoodleDocs
(copied from 2.7 docs)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Repositories}}
{{Repositories}}
''Note: This page contains information for site administrators.''
''Note: This page contains information for site administrators only.''
==Registering with Google==


==OAuth 2.0==
Each Moodle site  needs to be registered with Google in order to use the Google Drive, Docs or Picasa plugins. As part of the registration process, you will need to enter a URL (something like <nowiki>http://yourmoodlesite.org/admin/oauth2callback.php</nowiki>) which is provided on all Google Drive, Docs and Picasa plugins configuration pages in Moodle e.g. ''Administration > Site administration > Plugins > Repositories > Google Drive''.


Prior to Moodle 2.3, the [[Google Docs repository]] and [[Picasa web album repository]] and the [[Google Docs portfolio]] and [[Picasa portfolio]] could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com/2012/04/changes-to-deprecation-policies-and-api.html Google announced] to web application developers that they would be deprecating the service which Moodle was using to communicate with Google and strongly advised developers to move away from it. As a response to this change with Google's service, Moodle switched to use a new system for communicating with Google called 'OAuth 2.0'. The OAuth 2.0 system provides a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.
1) Visit the [https://code.google.com/apis/console#access Google APIs Console] (or the new URL [https://cloud.google.com/console/project#access Google Cloud APIs Console]) and sign into your google account.


==Registering with Google==
2) If it is your first time you will be asked to create a project:
Each Moodle site now needs to be registered with Google in order to use the Google Docs or Picasa plugins. The following will guide you through the process of registering with Google.
[[File:01g.png|center|thumb|400px]]
3) Give your project a name
[[File:02g.png|thumb|center|400px]]
4) If not already enabled, the Google Drive API needs enabling. Click "Enable an API":
[[File:03g.png|thumb|center|400px]]
5) Change Drive API to "On":
[[File:04g.png|thumb|center|400px]]
6) From the left menu, click "Credentials":
[[File:05g.png|thumb|center|400px]]
7) In the OAuth block, click "Create  new client ID"
[[File:06g.png|thumb|center|400px]]
8) Leave the Javascript redirect blank and add the redirect URL you have from ''Administration > Site administration > Plugins > Repositories > Google Drive'' and then click "Create client ID".You can also enter your branding details here.
[[File:08g.png|thumb|center|400px]]
9) Use the ID and secret you are given to enter on your set up page:
[[File:09g.png|thumb|center|400px]]
 
 
Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site in step 8. The same name and logo would then be displayed on the authorisation screen for each Moodle site.
 
Your site will then be registered with Google and you will be provided with a client ID and secret to configure all Google Drive, Docs and Picasa plugins.
 
Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site in step 7. The same name and logo would then be displayed on the authorisation screen for each Moodle site.


# Visit the [https://code.google.com/apis/console#access Google APIs Console] and sign into your google account. You will be asked to create a project if this is your first time using this form.
==Configuring the Google Drive and Picasa repositories==
# Click the button 'Create an OAuth 2.0 client ID'
# Enter the branding information 'Product name' (i.e. the name of your Moodle site) and 'Product logo' (i.e. your site logo). By providing a descriptive name and link to distinct image then your users will know they are signing into the correct place.
# Click the Next button
# In 'Client ID Settings' select 'Web application' as application type.
# Click the '(more options)' link next to 'Your site or hostname' then in 'Authorized Redirect URIs' enter the URL (something like <nowiki>http://yourmoodlesite.org/admin/oauth2callback.php</nowiki>) which is provided on the plugin configuration page in Moodle, and leave the 'Authorized JavaScript Origins' field blank
# Click the button 'Create client ID'


Your site will then be registered with Google and you will be presented with your details.
# Go to ''Administration > Site administration > Plugins > Repositories > Manage Repositories''
# Activate the Google Drive and/or Picasa repositories by selecting 'Enable and visible' in the dropdown menu
# Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
# Save changes


:8. Enter the 'Client ID' and 'Client secret' provided into the plugin configuration page in Moodle e.g. ''Settings > Site administration > Plugins > Repositories > Google Docs''.
==Configuring the Google Drive and Picasa portfolios==


Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.
# Go to ''Administration > Site administration > Plugins > Portfolios > Manage Portfolios''
# Activate the Google Drive and/or Picasa portfolios by selecting 'Enable and visible' in the dropdown menu
# Configure each portfolio by entering the client ID and secret
# Save changes




<gallery perrow=3 caption="Registering with Google - click on each to enlarge">
Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.
Image:google_oauth1.png|1. Create project
File:google_oauth2.png|2. Creating an OAuth 2.0 Client ID
File:google_oauth3.png|3. Branding information
File:google_oauth4.png|6. Client ID settings
File:google_oauth5.png|Registered details
File:google_oauth6.png|Authorisation screen
</gallery >


[[Category:Portfolios]]
[[Category:Portfolios]]
[[Category:Site administration]]
[[Category:Site administration]]
[[es:Configuración de Google OAuth 2.0]]

Latest revision as of 07:27, 15 August 2014

Note: This page contains information for site administrators only.

Registering with Google

Each Moodle site needs to be registered with Google in order to use the Google Drive, Docs or Picasa plugins. As part of the registration process, you will need to enter a URL (something like http://yourmoodlesite.org/admin/oauth2callback.php) which is provided on all Google Drive, Docs and Picasa plugins configuration pages in Moodle e.g. Administration > Site administration > Plugins > Repositories > Google Drive.

1) Visit the Google APIs Console (or the new URL Google Cloud APIs Console) and sign into your google account.

2) If it is your first time you will be asked to create a project:

01g.png

3) Give your project a name

02g.png

4) If not already enabled, the Google Drive API needs enabling. Click "Enable an API":

03g.png

5) Change Drive API to "On":

04g.png

6) From the left menu, click "Credentials":

05g.png

7) In the OAuth block, click "Create new client ID"

06g.png

8) Leave the Javascript redirect blank and add the redirect URL you have from Administration > Site administration > Plugins > Repositories > Google Drive and then click "Create client ID".You can also enter your branding details here.

08g.png

9) Use the ID and secret you are given to enter on your set up page:

09g.png


Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site in step 8. The same name and logo would then be displayed on the authorisation screen for each Moodle site.

Your site will then be registered with Google and you will be provided with a client ID and secret to configure all Google Drive, Docs and Picasa plugins.

Tip: If you have more than one Moodle site to register with Google, you can add an authorized redirect URI for each site in step 7. The same name and logo would then be displayed on the authorisation screen for each Moodle site.

Configuring the Google Drive and Picasa repositories

  1. Go to Administration > Site administration > Plugins > Repositories > Manage Repositories
  2. Activate the Google Drive and/or Picasa repositories by selecting 'Enable and visible' in the dropdown menu
  3. Configure each repository by entering the client ID and secret. Make sure you don't include any white space in the text boxes!
  4. Save changes

Configuring the Google Drive and Picasa portfolios

  1. Go to Administration > Site administration > Plugins > Portfolios > Manage Portfolios
  2. Activate the Google Drive and/or Picasa portfolios by selecting 'Enable and visible' in the dropdown menu
  3. Configure each portfolio by entering the client ID and secret
  4. Save changes


Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.