You are here

Home » API reference » Social Auth Google 8

README.txt in Social Auth Google 8

Same filename and directory in other branches
  1. 8.2 README.txt
SOCIAL AUTH GOOGLE MODULE

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * How it works
 * Support requests

INTRODUCTION
------------

Social Auth Google Module is a Google Authentication integration for Drupal. It
is based on the Social Auth and Social API projects

It adds to the site:
* A new url: /user/login/google.
* A settings form on /admin/config/social-api/social-auth/google page.
* A Google+ Logo in the Social Auth Login block.

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

This module requires the following modules:

 * Social Auth (https://drupal.org/project/social_auth)
 * Social API (https://drupal.org/project/social_api)

RECOMMENDED MODULES
-------------------

 * Composer Manager (https://www.drupal.org/project/composer_manager):
   This module will help to install the Google API PHP Client library,
   which is a library required to make user authentication.

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

 * Download Google API PHP Client library
   (https://github.com/google/google-api-php-client). We recommend to use
   Composer Manager module to install the library.

 * Install the dependencies: Social API and Social Auth.

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-8
   for further information.

 * A more comprehensive installation instruction for Drupal 8 can be found at
   https://www.drupal.org/node/2764227.

CONFIGURATION
-------------

 * Add your Google project OAuth information in
   Configuration » User Authentication » Google.

 * Place a Social Auth Login block in Structure » Block Layout.

 * If you already have a Social Auth Login block in the site, rebuild the cache.


HOW IT WORKS
------------

User can click on the Google+ logo on the Social Auth Login block
You can also add a button or link anywhere on the site that points 
to /user/login/google, so theming and customizing the button or link
is very flexible.

When the user opens the /user/login/google link, it automatically takes
user to Google Accounts for authentication. Google then returns the user to
Drupal site. If we have an existing Drupal user with the same email address
provided by Google, that user is logged in. Otherwise a new Drupal user is
created.

SUPPORT REQUESTS
----------------

Before posting a support request, carefully read the installation
instructions provided in module documentation page.

Before posting a support request, check Composer Manager status report at
admin/reports/composer-manager. This status page will show the Google API PHP
Client version if Drupal can detect it.

Before posting a support request, check Recent log entries at
admin/reports/dblog

Once you have done this, you can post a support request at module issue queue:
https://www.drupal.org/sandbox/gvso/2763739

When posting a support request, please inform what does the status report say
at admin/reports/composer-manager and if you were able to see any errors in
Recent log entries.

File

README.txt
View source 
  1. SOCIAL AUTH GOOGLE MODULE

  2. 

  3. CONTENTS OF THIS FILE

  4. ---------------------

  5. 

  6.  * Introduction

  7.  * Requirements

  8.  * Recommended modules

  9.  * Installation

  10.  * Configuration

  11.  * How it works

  12.  * Support requests

  13. 

  14. INTRODUCTION

  15. ------------

  16. 

  17. Social Auth Google Module is a Google Authentication integration for Drupal. It

  18. is based on the Social Auth and Social API projects

  19. 

  20. It adds to the site:

  21. * A new url: /user/login/google.

  22. * A settings form on /admin/config/social-api/social-auth/google page.

  23. * A Google+ Logo in the Social Auth Login block.

  24. 

  25. REQUIREMENTS

  26. ------------

  27. 

  28. This module requires the following modules:

  29. 

  30.  * Social Auth (https://drupal.org/project/social_auth)

  31.  * Social API (https://drupal.org/project/social_api)

  32. 

  33. RECOMMENDED MODULES

  34. -------------------

  35. 

  36.  * Composer Manager (https://www.drupal.org/project/composer_manager):

  37.    This module will help to install the Google API PHP Client library,

  38.    which is a library required to make user authentication.

  39. 

  40. INSTALLATION

  41. ------------

  42. 

  43.  * Download Google API PHP Client library

  44.    (https://github.com/google/google-api-php-client). We recommend to use

  45.    Composer Manager module to install the library.

  46. 

  47.  * Install the dependencies: Social API and Social Auth.

  48. 

  49.  * Install as you would normally install a contributed Drupal module. See:

  50.    https://drupal.org/documentation/install/modules-themes/modules-8

  51.    for further information.

  52. 

  53.  * A more comprehensive installation instruction for Drupal 8 can be found at

  54.    https://www.drupal.org/node/2764227.

  55. 

  56. CONFIGURATION

  57. -------------

  58. 

  59.  * Add your Google project OAuth information in

  60.    Configuration » User Authentication » Google.

  61. 

  62.  * Place a Social Auth Login block in Structure » Block Layout.

  63. 

  64.  * If you already have a Social Auth Login block in the site, rebuild the cache.

  65. 

  66. 

  67. HOW IT WORKS

  68. ------------

  69. 

  70. User can click on the Google+ logo on the Social Auth Login block

  71. You can also add a button or link anywhere on the site that points 

  72. to /user/login/google, so theming and customizing the button or link

  73. is very flexible.

  74. 

  75. When the user opens the /user/login/google link, it automatically takes

  76. user to Google Accounts for authentication. Google then returns the user to

  77. Drupal site. If we have an existing Drupal user with the same email address

  78. provided by Google, that user is logged in. Otherwise a new Drupal user is

  79. created.

  80. 

  81. SUPPORT REQUESTS

  82. ----------------

  83. 

  84. Before posting a support request, carefully read the installation

  85. instructions provided in module documentation page.

  86. 

  87. Before posting a support request, check Composer Manager status report at

  88. admin/reports/composer-manager. This status page will show the Google API PHP

  89. Client version if Drupal can detect it.

  90. 

  91. Before posting a support request, check Recent log entries at

  92. admin/reports/dblog

  93. 

  94. Once you have done this, you can post a support request at module issue queue:

  95. https://www.drupal.org/sandbox/gvso/2763739

  96. 

  97. When posting a support request, please inform what does the status report say

  98. at admin/reports/composer-manager and if you were able to see any errors in

  99. Recent log entries.