From 35dfc720c82a6e42031acb3dcd6172135bb95cfc Mon Sep 17 00:00:00 2001 From: Syed Sajjad Hussain Shah <52817156+syedsajjadkazmii@users.noreply.github.com> Date: Tue, 29 Nov 2022 16:03:20 +0500 Subject: [PATCH] feat: add enable social auth locally docs (#687) VAN-1180 --- README.rst | 4 ++-- docs/how_tos/enable_social_auth.rst | 14 ++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) create mode 100644 docs/how_tos/enable_social_auth.rst diff --git a/README.rst b/README.rst index ed75085c..9322d4ee 100644 --- a/README.rst +++ b/README.rst @@ -41,10 +41,10 @@ This MFE is bundled with `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 `_ for enabling Social Sign-on Buttons (SSO) locally + Environment Variables/Setup Notes --------------------------------- diff --git a/docs/how_tos/enable_social_auth.rst b/docs/how_tos/enable_social_auth.rst new file mode 100644 index 00000000..bf402d72 --- /dev/null +++ b/docs/how_tos/enable_social_auth.rst @@ -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 `_ 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.