Differences

This shows you the differences between two versions of the page.

--- radius:login_otp [2024/02/13 15:12] – system
+++ radius:login_otp [2024/02/13 16:04] (current) – [Activating the system for sending OTPs] system
@@ Line 7: / Line 7: @@
 ====== OTP ======
 ===== Background =====
-  * A One Time Password or OTP is a common method used for user verification.
+  * A One Time Password or OTP is a common method of user verification.
-  * A user will typically provide a **mobile number** or **email address**.
+  * A user usually enters a **cell phone number** or an **email address**.
-  * The system will then send a code to the mobile number using SMS or to the email address using an email.
+  * The system then sends a code via SMS to the cell phone number or via e-mail to the email address.
-  * This code will be used by the user to validate itself to the system.
+  * This code is used by the user to verify themselves to the system.
-  * As for February 2023 RADIUSdesk includes support for OTP verification for Captive Portal (Hotspot) users.
+  * From February 2023, RADIUSdesk will provide support for OTP verification for Captive Portal (Hotspot) users.
   * We support the following ways to send the OTP:
         * SMS
         * Email
   * We support OTP with:
-        * Permanent User Registration
+        * Permanent user registration
         * Click-To-Connet
-  * The rest of this page will discuss the configuration and technical detail of the OTP functionality.
+  * The rest of this page deals with the configuration and technical details of the OTP functionality.
-===== Enable System To Send OTPs =====
+===== Activating the system for sending OTPs =====
-  * In order for RADIUSdesk to send an OTP you have to configure the system to be able to send the OTP using email or SMS.
+  * For RADIUSdesk to be able to send an OTP, you must configure the system so that it can send the OTP by email or SMS.
-  * RADIUSdesk allows for you to configure a system wide configuration but it also allows you to define per cloud settings which will take preference over the system wide settings.
+  * RADIUSdesk offers you the option of making a system-wide configuration, but you can also define settings per cloud, which then take precedence over the system-wide settings.
-  * See the following screenshot for the email configuration:
+  * The following screenshot shows the email configuration:
 <panel type="primary">
 {{:radius:login_pages:sendgrid_config.png?nolink|}}
 </panel>
-  * We support Sendgrid and normal SMTP as a transport for the email.
+  * We support Sendgrid and normal SMTP as a means of transport for the email.
-  * After you specified the config press **Save**.
+  * Once you have defined the configuration, click **Save**.
-  * After you saved the configuration you can test it by clicking the **Test Email Settings** button.
+  * Once you have saved the configuration, you can test it by clicking on the **Test Email Settings** button.
-  * You can also view the history of all the emails that the system sent out using this particular configuration by clicking the **Show Sent History** button.
+  * You can also view the history of all emails that the system has sent with this particular configuration by clicking on the **Show Sent History** button.
-  * See the following screenshot for the SMS configuration.
+  * In the following screenshot you can see the SMS configuration.
 <panel type="primary">
@@ Line 37: / Line 37: @@
 </panel>
-  * Most SMS providers has an API that you use to send SMSs.
+  * Most SMS providers have an API that you can use to send SMS.
-  * RADIUSdesk allows you to specify two SMS Providers. Both can be active however the system will only use the first active one it finds.
+  * RADIUSdesk allows you to specify two SMS providers. Both can be active, but the system will only use the first active one it finds.
-  * As with the email settings you are also able to test the SMS Settings after configuration.
+  * As with the email settings, you can also test the SMS settings after configuration.
-  * You can also view the history of all the SMSs that the system sent out using that particular configuration by clicking the **Show Sent History** button.
+  * You can also view the history of all SMS that the system has sent with this particular configuration by clicking the **Show Sent History** button.
-<WRAP center round tip 100%>
+<alert type="info">
-  * These settings can also be specified per Cloud.
+  * These settings can also be set per cloud.
   * Go to **Other** -> **Clouds**.
-  * Simply select the cloud for which you want to add more specific settings and edit it.
+  * Simply select the cloud for which you want to add more specific settings and edit them.
-  * These settings will take preference.
+  * These settings will then take precedence.
-</WRAP>
+</alert>
-===== OTP For User Registration =====
+===== OTP for user registration =====
 <panel type="primary">
 {{:radius:login_pages:user_registration.png?nolink|}}
 </panel>
-  * The above screenshot should be mostly self explanatory.
+  * The screenshot above should be self-explanatory.
-  * There is however one important point that should be mentioned on using Email for OTP.
+  * However, there is one important point that should be mentioned when using email for OTP.
-  * We sit with a bit of a chicken and egg situation since the person will need Internet access to get to their email to retrieve the OTP.
+  * We are in a bit of a chicken and egg situation as the person needs internet access to check their email and receive the OTP.
-  * We will thus provide them temporary Internet access for this action.
+  * So we will provide them with temporary internet access for this action.
   * This is what the **Temp login user** is for.
-  * You are advised to create a dedicated user with a special profile for this purpose.
+  * We recommend that you create a separate user with a special profile for this purpose.
   * The profile should be
         * Time limited. e.g. Session-Timeout should be 360 seconds (5minutes)
         * The bandwidth should be limited.
-  * This will allow for the user that registers to retrieve the OTP from their email but not much beyond that in terms of Internet connection.
+  * So the user who registers can retrieve the OTP from their email, but not much beyond that in terms of internet connection.
-  * The email with the OTP will also contain a link which the user can click to confirm the OTP to the system.
+  * The email with the OTP also contains a link that the user can click on to confirm the OTP to the system.
-  * This makes is easy if the WebView with the Captive Portal Login Page closed while the user retrieved the OTP from their email.
+  * This makes it easy when the WebView with the Captive Portal login page is closed while the user is retrieving the OTP from their email.
 ===== OTP For Click To Connect =====
@@ Line 71: / Line 71: @@
 </panel>
-  * With OTP for Click To Connect there are one of two options.
+  * With OTP for Click To Connect, there is one of two options.
-  * If you select the email option for the OTP, again you have to provide temporary Internet access to the user as with User Registration above.
+  * If you choose the email option for the OTP, you will need to provide the user with temporary internet access again, as with user registration above.
-  * If you select SMS option (the user's mobile number) you don't need to provide anything since the OTP will be delivered as an SMS.
+  * If you choose the SMS option (the user's cell phone number), you do not need to do anything as the OTP will be delivered as an SMS.
-  * We also again added a link in the email for the user to conveniently confirm the OTP by clicking on the link.
+  * We have also included a link in the email again for the user to conveniently confirm the OTP by clicking on the link.
 ===== Some Technical Items =====
 ==== Expiry of the OTP ====
   * The current expiry time for an OTP is two minutes.
-  * This can be adjusted by editing **/var/www/html/cake4/rd_cake/src/Controller/RegisterUsersController.php** and **/var/www/html/cake4/rd_cake/src/Controller/DataCollectortsController.php** files.
+  * This can be adjusted by editing the files **/var/www/html/cake4/rd_cake/src/Controller/RegisterUsersController.php** and **/var/www/html/cake4/rd_cake/src/Controller/DataCollectortsController.php** files.
-  * Look for this line and adjust acordingly.
+  * Search for this line and adjust it accordingly.
 <code php>
 protected $valid_minutes = 2; //The time that an OTP will be valid (in minutes)
@@ Line 87: / Line 87: @@
 ==== Disconnecting Temp Connection ====
-  * The URL link in the email will cause a redirect to a special CoovaChilli URL that will log the user out (http://1.0.0.0).
+  * The URL link in the email leads to a redirection to a special CoovaChilli URL that logs the user out (http://1.0.0.0).
-  * For this to happen the user should be connected to the Captive Portal so that this URL can log them out.
+  * For this to happen, the user must be connected to the captive portal so that this URL can log them out.
 <code php>
@@ Line 107: / Line 107: @@
 </code>
-<WRAP center round important 100%>
+<alert type="warning">
 We are still looking for a similar way to disconnect users on a Mikrotik based Hotspot.
-</WRAP>
+</alert>