You are here

README.txt in Google Auth 8

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

  * Summary
  * Requirements
  * Installation
  * Google Configuration
  * Configuration
  * Credits


SUMMARY
-------

This module allows you to authenticate with google,
and use this authentication to carry other api requests.

This module don't have functionality of its own,
but can help you to manage accounts, authenticate with google
(i.e. get access token) and use this authentication to carry api requests.

This module allows you to enter google account details like client id,
client secret key, developer key, select google services to be enabled
and gets the OAuth2 access token from google.

The account manage page also shows a authenticate link if the account is not
authenticated and Revoke link if the account is authenticated.


REQUIREMENTS
------------

1. Google client library - You need to download google api php client library
from http://code.google.com/p/google-api-php-client/downloads/list


INSTALLATION
------------

1. Copy this module directory to your modules directory.

2. Download the latest release of google php client library from
   https://github.com/google/google-api-php-client/releases and
   extract it in libraries folder of the site, mostly located at
   libraries, the path is 'libraries/google-api-php-client/vendor'

   You may use composer to install without downloading the file which is fine.
   a) If you use composer then goto libraries folder in core, create google-api-php-client and install
   using composer i.e. composer require google/apiclient:"^2.0"

   b) If you download then goto libraries folder in core and extract the tar

   The final path after installation should be 'libraries/google-api-php-client/vendor/autoload.php'

   Note that version 8.x-1.0 is tested and will only work with google-api-php-client 2.4 or later,

3. Enable the module and manage accounts at admin/config/services/gauth.


GOOGLE CONFIGURATION
--------------------
1. Visit https://console.developers.google.com/project
2. Create a new project with appropriate details,
   if you don't have a project created.
3. Under "Dashboard" on left sidebar click on "Use Google API" and enable the services which you want to use by clicking the links.
   i.e. Google Analytics, etc
   You can check enabled apis as a separate tab on the page.
4. Click on "Credentials" on the left sidebar.
5. If you have not created a oauth2.0 client id then create it
   with appropriate details i.e.
     Application Type: Web Application,
     Name: Name of the application
     Authorized Redirect uri's: You can copy the uri shown when you create a google oauth account in the admin settings.
6. Copy the client id, client secret, api key
   to configuration form of the module.


CONFIGURATION
-------------
1. Configure the api accounts at admin/config/services/gauth_account.

2. You can add new account or update existing accounts.
    Specify unique name by which you can identify the account.
    Add the client id, client secret and api key from you google project page
    i.e. https://code.google.com/apis/console/
    Select services for which this account will be used eg Google Calendar, etc.

3. On save of the form it will ask for access,
   click allow access so that the account gets authenticated.

4. Ready to use this account for api access.


CREDITS
-------

The idea came up from no module providing google oauth2 authentication in drupal 7 and now
in drupal 8 the module is more powerful than before.

Current Maintainer: Sadashiv Dalvi <dalvisadashiv@gmail.com>

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Summary
  4. * Requirements
  5. * Installation
  6. * Google Configuration
  7. * Configuration
  8. * Credits
  9. SUMMARY
  10. -------
  11. This module allows you to authenticate with google,
  12. and use this authentication to carry other api requests.
  13. This module don't have functionality of its own,
  14. but can help you to manage accounts, authenticate with google
  15. (i.e. get access token) and use this authentication to carry api requests.
  16. This module allows you to enter google account details like client id,
  17. client secret key, developer key, select google services to be enabled
  18. and gets the OAuth2 access token from google.
  19. The account manage page also shows a authenticate link if the account is not
  20. authenticated and Revoke link if the account is authenticated.
  21. REQUIREMENTS
  22. ------------
  23. 1. Google client library - You need to download google api php client library
  24. from http://code.google.com/p/google-api-php-client/downloads/list
  25. INSTALLATION
  26. ------------
  27. 1. Copy this module directory to your modules directory.
  28. 2. Download the latest release of google php client library from
  29. https://github.com/google/google-api-php-client/releases and
  30. extract it in libraries folder of the site, mostly located at
  31. libraries, the path is 'libraries/google-api-php-client/vendor'
  32. You may use composer to install without downloading the file which is fine.
  33. a) If you use composer then goto libraries folder in core, create google-api-php-client and install
  34. using composer i.e. composer require google/apiclient:"^2.0"
  35. b) If you download then goto libraries folder in core and extract the tar
  36. The final path after installation should be 'libraries/google-api-php-client/vendor/autoload.php'
  37. Note that version 8.x-1.0 is tested and will only work with google-api-php-client 2.4 or later,
  38. 3. Enable the module and manage accounts at admin/config/services/gauth.
  39. GOOGLE CONFIGURATION
  40. --------------------
  41. 1. Visit https://console.developers.google.com/project
  42. 2. Create a new project with appropriate details,
  43. if you don't have a project created.
  44. 3. Under "Dashboard" on left sidebar click on "Use Google API" and enable the services which you want to use by clicking the links.
  45. i.e. Google Analytics, etc
  46. You can check enabled apis as a separate tab on the page.
  47. 4. Click on "Credentials" on the left sidebar.
  48. 5. If you have not created a oauth2.0 client id then create it
  49. with appropriate details i.e.
  50. Application Type: Web Application,
  51. Name: Name of the application
  52. Authorized Redirect uri's: You can copy the uri shown when you create a google oauth account in the admin settings.
  53. 6. Copy the client id, client secret, api key
  54. to configuration form of the module.
  55. CONFIGURATION
  56. -------------
  57. 1. Configure the api accounts at admin/config/services/gauth_account.
  58. 2. You can add new account or update existing accounts.
  59. Specify unique name by which you can identify the account.
  60. Add the client id, client secret and api key from you google project page
  61. i.e. https://code.google.com/apis/console/
  62. Select services for which this account will be used eg Google Calendar, etc.
  63. 3. On save of the form it will ask for access,
  64. click allow access so that the account gets authenticated.
  65. 4. Ready to use this account for api access.
  66. CREDITS
  67. -------
  68. The idea came up from no module providing google oauth2 authentication in drupal 7 and now
  69. in drupal 8 the module is more powerful than before.
  70. Current Maintainer: Sadashiv Dalvi