You are here

Home » API reference » Social Auth Google 8.2

README.txt in Social Auth Google 8.2

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

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * How it works
 * Support requests
 * Maintainers


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

Social Auth Google 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)


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

 * Run composer to install the dependencies.
   composer require "drupal/social_auth_google:^2.0"

 * 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/docs/8/modules/social-api/social-api-2x/social-auth-2x/social-auth-google-2x-installation


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

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

After Google has returned the user to your site, the module compares the user id
or email address provided by Google. If the user has previously registered using
Google or your site already has an account with the same email address, the user
is logged in. If not, a new user account is created. Also, a Google account can
be associated with an authenticated user.


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

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

 * 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/project/issues/social_auth_google

 * When posting a support request, please inform if you were able to see any
   errors in the Recent Log entries.


MAINTAINERS
-----------

Current maintainers:
 * Getulio Sánchez (gvso) - https://www.drupal.org/u/gvso
 * Himanshu Dixit (himanshu-dixit) - https://www.drupal.org/u/himanshu-dixit

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * How it works

  9.  * Support requests

  10.  * Maintainers

  11. 

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. Social Auth Google is a Google authentication integration for Drupal. It is

  17. based on the Social Auth and Social API projects

  18. 

  19. It adds to the site:

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

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

  22.  * A Google logo in the Social Auth Login block.

  23. 

  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. 

  34. INSTALLATION

  35. ------------

  36. 

  37.  * Run composer to install the dependencies.

  38.    composer require "drupal/social_auth_google:^2.0"

  39. 

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

  41. 

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

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

  44.    for further information.

  45. 

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

  47.    https://www.drupal.org/docs/8/modules/social-api/social-api-2x/social-auth-2x/social-auth-google-2x-installation

  48. 

  49. 

  50. CONFIGURATION

  51. -------------

  52. 

  53.  * Add your Google project OAuth information in

  54.    Configuration » User Authentication » Google.

  55. 

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

  57. 

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

  59. 

  60. 

  61. HOW IT WORKS

  62. ------------

  63. 

  64. The user can click on the Google logo on the Social Auth Login block

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

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

  67. is very flexible.

  68. 

  69. After Google has returned the user to your site, the module compares the user id

  70. or email address provided by Google. If the user has previously registered using

  71. Google or your site already has an account with the same email address, the user

  72. is logged in. If not, a new user account is created. Also, a Google account can

  73. be associated with an authenticated user.

  74. 

  75. 

  76. SUPPORT REQUESTS

  77. ----------------

  78. 

  79.  * Before posting a support request, carefully read the installation

  80.    instructions provided in module documentation page.

  81. 

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

  83.    admin/reports/dblog

  84. 

  85.  * Once you have done this, you can post a support request at module issue

  86.    queue: https://www.drupal.org/project/issues/social_auth_google

  87. 

  88.  * When posting a support request, please inform if you were able to see any

  89.    errors in the Recent Log entries.

  90. 

  91. 

  92. MAINTAINERS

  93. -----------

  94. 

  95. Current maintainers:

  96.  * Getulio Sánchez (gvso) - https://www.drupal.org/u/gvso

  97.  * Himanshu Dixit (himanshu-dixit) - https://www.drupal.org/u/himanshu-dixit