Andal.LND/frontend-app-authn
6
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: add enable social auth locally docs (#687)

Browse Source 
VAN-1180
This commit is contained in:
Syed Sajjad Hussain Shah
2022-11-29 16:03:20 +05:00
committed by GitHub
parent 3ca2739fce
commit 35dfc720c8
2 changed files with 16 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.rst
View File

@@ -41,10 +41,10 @@ This MFE is bundled with `Devstack <https://github.com/openedx/devstack>`_, see
5. Once the dev server is up, visit http://localhost:1999 to access the MFE
* Note: Social Sign-on Buttons (SSO) will not be available until configured locally.
.. image:: ./docs/images/frontend-app-authn-localhost-preview.png
**Note:** Follow `Enable social auth locally <docs/how_tos/enable_social_auth.rst>`_ for enabling Social Sign-on Buttons (SSO) locally
Environment Variables/Setup Notes
---------------------------------

14
docs/how_tos/enable_social_auth.rst Normal file
View File

@@ -0,0 +1,14 @@
Enable Social Auth Locally
--------------------------
Please follow the steps below to enable social auth (SSO) locally.
1. Follow `Enabling Third Party Authentication <https://edx.readthedocs.io/projects/edx-installing-configuring-and-running/en/latest/configuration/tpa/index.html>`_ for backend configuration.
2. Authn has a component for rendering Social Auth providers at frontend which goes through each provider.
* If the provider has an ``iconImage``, then it will be rendered as image in SSO button.
* If ``iconImage`` is not available in provider, but the provider's ``iconClass`` is from the supported icon classes ``['apple', 'facebook', 'google', 'microsoft']`` then it is used as icon image.
* If ``iconClass`` doesn't match the supported icon classes then the ``faSignInAlt`` from font awesome icons is used as icon image for SSO button.