Google OAuth 2.0 setup: diferència entre les revisions

Revisió de 15:26, 26 juny 2012

Note: This page contains information for site administrators only.

OAuth 2.0

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, 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.

Registering with Google

Each Moodle site now needs to be registered with Google in order to use the Google 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 Docs and Picasa plugins configuration pages in Moodle e.g. Settings > Site administration > Plugins > Repositories > Google Docs.

Visit the 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.
Click the link on the left "API Access"
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. the URL of 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 http://yourmoodlesite.org/admin/oauth2callback.php) from 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 provided with a client ID and secret to configure all Google 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.

Registering with Google - click on each to enlarge
1. Create project
2. Creating an OAuth 2.0 Client ID
3. Branding information
6. Client ID settings
Registered details
Authorisation screen

Configuring the Google Docs and Picasa repositories

Go to Settings > Site administration > Plugins > Repositories > Manage Repositories
Activate the Google Docs 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

Configuring the Google Docs and Picasa portfolios

Go to Settings > Site administration > Plugins > Portfolios > Manage Portfolios
Activate the Google Docs 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

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

@@ Línia 1: / Línia 1: @@
-Prior to Moodle 2.3, Google Docs and Picasa repository plugins and portfolio plugins could be used without any configuration or registration with Google. In April 2012, [http://googledevelopers.blogspot.com.au/2012/04/changes-to-deprecation-policies-and-api.html Google Announced] to web application developers that they would be deprecated 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', starting with Moodle 2.3. The OAuth 2.0 system providers and a better security system and more friendly experience to Moodle users, though it requires some additional configuration in Moodle.
+{{Repositories}}
+''Note: This page contains information for site administrators only.''
+==OAuth 2.0==
+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.
 ==Registering with Google==
-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.
-# You will need to be signed into a google account
+Each Moodle site now needs to be registered with Google in order to use the Google 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 Docs and Picasa plugins configuration pages in Moodle e.g. ''Settings > Site administration > Plugins > Repositories > Google Docs''.
-# Visit the [Google API's Console https://code.google.com/apis/console#access]
-# You will be asked to create a project if this is your first time using this form.
+# 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.
-# You need to click the button marked 'Create an OAuth 2.0 client ID..'
+# Click the link on the left "API Access"
-# You will be asked to enter branding information including a 'Product name' and 'Product 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 button 'Create an OAuth 2.0 client ID'
-# Next you will be asked for 'Client ID Settings'
+# Enter the branding information 'Product name' (i.e. the name of your Moodle site) and 'Product logo' (i.e. the URL of 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.
-## For Application type, select 'Web application'
+# Click the Next button
-## Next to 'Your site or hostname' click '(more options)'
+# In 'Client ID Settings' select 'Web application' as application type.
-## In 'Authorized Redirect URIs' enter the URL which was provided in your Moodle settings page. (usually http://yourmoodle/admin/oauth2callback.php)
+# 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>) from the plugin configuration page in Moodle, and leave the 'Authorized JavaScript Origins' field blank
-## In 'Authorized JavaScript Origins' leave the field blank
+# Click the button 'Create client ID'
-# Click 'Create client ID'
-# Your site is now registered with Google and you will be presented with your details.
+Your site will then be registered with Google and you will be provided with a client ID and secret to configure all Google Docs and Picasa plugins.
-# Enter the 'Client ID' and 'Client secret' provided into your Moodle settings page
+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.
+<gallery perrow=3 caption="Registering with Google - click on each to enlarge">
+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 >
+==Configuring the Google Docs and Picasa repositories==
+# Go to ''Settings > Site administration > Plugins > Repositories > Manage Repositories''
+# Activate the Google Docs 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
+==Configuring the Google Docs and Picasa portfolios==
+# Go to ''Settings > Site administration > Plugins > Portfolios > Manage Portfolios''
+# Activate the Google Docs 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
+Once configured, Google will present Moodle users with a nice authorisation screen with your Moodle site name and logo for your users to authorise.
+[[Category:Portfolios]]
+[[Category:Site administration]]

Documentation