Revision: 51ee4e7d31

Create Wiki Page

Restore Revision

Administrator edited on Jul 13, 2021, 4:48:15 PM

@@ -0,0 +1,40 @@
+
+##Enable Two Factor Authentication (2FA)
+
+Activate two factor authentication by running the command.
+
+`bench --site [sitename] set-config enable_two_factor_auth true`
+
+Specify the following in System Settings
+
+* The method of OTP validation (OTP App = TOTP using Soft or Hard Token while Email/SMS = HOTP using Email or SMS
+* The expiry time for the QR Code on the server if OTP App is specified
+* The OTP Issuer Name.
+
+<img alt="Enable Two Factor Auth" class="screenshot" src="/files/twofactor-118fb4c.png">
+
+
+On activation of 2FA from setup, it is also activated for the Role "All". In this way, all users including the Administrator have to perform a 2nd level authentication with a token. By unchecking the "Two Factor Authentication" checkbox in the "All" role and enabling it in other roles, the need to login with a token can be limited to specific roles. 2FA does not apply to login by Web Users and API login
+
+<img alt="Role Enable Two Factor Auth" class="screenshot" src="/files/twofactor-256cb3b.png">
+
+If using SMS authentication, please make sure that your SMS settings are updated
+
+<img alt="SMS Settings" class="screenshot" src="/files/twofactor-35bcb9e.png">
+
+If using Email, make sure that your outgoing Email account settings are updated
+
+<img alt="Email Settings" class="screenshot" src="/files/twofactor-46452f1.png">
+
+When the new user tries to log in for the first time in a system that has two-factor authentication enabled and which has the authentication option as OTP App, an email is sent containing a link to the QR Code.
+
+<img alt="Email Notify Two Factor" class="screenshot" src="/files/twofactor-5e34710.png">
+<img alt="QR Code Page" class="screenshot" src="/files/twofactor-6f786ba.png">
+
+Scanning the QR Code with an authentication app like Google Authenticator registers the access for the user and automatically starts to generate tokens that can be used to login
+
+<img alt="Two Factor Scan App" class="screenshot" src="/files/twofactor_app8d48e9.jpeg">
+
+If either of Email/SMS is used as the authentication method, you get notifications also
+
+<img alt="Email and SMS" class="screenshot" src="/files/twofactor-8172bd1.png">