Merge pull request #333 from aspnetzero/add-qr-login-document

ismcagdas · web-flow · commit b5bae98093a4 · 2025-03-18T10:45:25.000+03:00
Add QR Login feature documentation and update navigation links
diff --git a/docs/en/Features-Angular-Qr-Login.md b/docs/en/Features-Angular-Qr-Login.md
@@ -0,0 +1,40 @@
+# QR Login Integration in ASP.NET Zero with MAUI
+
+## Introduction
+ ASP.NET Zero offers a QR Login feature which allows users to log in to the web application by scanning a QR code from the MAUI application. This document explains how to enable and use QR Login in ASP.NET Zero with MAUI.
+
+## Enabling QR Login
+Before you can use the QR Login functionality, it needs to be enabled in the ASP.NET Zero web application settings. Follow these steps to enable QR Login:
+
+1. Navigate to **Settings** in the ASP.NET Zero Web application.
+2. Go to the **User Management** tab, locate the **QR Login** setting, and enable it.
+3. Save the settings.
+
+Once enabled, the login page on the web application will display a QR code for authentication.
+
+> **Note:** After enabling QR Login on the Host Settings page, each tenant can independently enable or disable the QR Login feature in their specific tenant settings.
+
+![Qr Code on Login Page](images/login-page-with-qr-login.png)
+
+## Using QR Login in MAUI
+The MAUI application allows users to authenticate by scanning the QR code displayed on the web login page. Here’s how users can log in through QR Login:
+
+1. Open the **MAUI application** and log in.
+2. Navigate to the **Sidebar Menu**.
+3. Select **QR Login** from the menu.
+4. If you haven't granted camera permission before, allow access to the camera.
+5. The QR Code Reader will activate.
+6. Scan the QR code displayed on the web application's login page.
+7. If the QR code is valid, you will be automatically logged in to the web application.
+
+## One-Way Authentication
+QR Login in ASP.NET Zero provides a streamlined authentication flow. It supports one-way authentication, meaning that the user can scan the QR code without entering credentials manually, assuming they are already authenticated in the MAUI app.
+
+![Qr Login Authentication](images/qr-login-authentication.gif)
+
+## Summary
+QR Login provides authentication method for users who are already signed into the MAUI app. By scanning a QR code from the web login page, users can instantly access the web application without entering credentials again. 
+
+## Next
+
+- [Sign Up](Features-Angular-Sign-Up)
diff --git a/docs/en/Features-Angular-Token-Based-Authentication.md b/docs/en/Features-Angular-Token-Based-Authentication.md
@@ -30,4 +30,4 @@ Authorization to the header as "**Bearer &lt;accessToken&gt;**". And the result
 
 ## Next
 
-- [Sign Up](Features-Angular-Sign-Up)
+- [Passwordless Login](Features-Passwordless-Login)
diff --git a/docs/en/Features-Mvc-Core-Forgot-Password.md b/docs/en/Features-Mvc-Core-Forgot-Password.md
@@ -6,5 +6,5 @@ If a user forgets their password, it can be retrieved by clicking the **Forgot P
 
 ## Next
 
-- [Sign Up](Features-Mvc-Core-Sign-Up)
+- [Passwordless Login](Features-Passwordless-Login)
 
diff --git a/docs/en/Features-Mvc-Core-Qr-Login.md b/docs/en/Features-Mvc-Core-Qr-Login.md
@@ -0,0 +1,40 @@
+# QR Login Integration in ASP.NET Zero with MAUI
+
+## Introduction
+ ASP.NET Zero offers a QR Login feature which allows users to log in to the web application by scanning a QR code from the MAUI application. This document explains how to enable and use QR Login in ASP.NET Zero with MAUI.
+
+## Enabling QR Login
+Before you can use the QR Login functionality, it needs to be enabled in the ASP.NET Zero web application settings. Follow these steps to enable QR Login:
+
+1. Navigate to **Settings** in the ASP.NET Zero Web application.
+2. Go to the **User Management** tab, locate the **QR Login** setting, and enable it.
+3. Save the settings.
+
+Once enabled, the login page on the web application will display a QR code for authentication.
+
+> **Note:** After enabling QR Login on the Host Settings page, each tenant can independently enable or disable the QR Login feature in their specific tenant settings.
+
+![Qr Code on Login Page](images/login-page-with-qr-login.png)
+
+## Using QR Login in MAUI
+The MAUI application allows users to authenticate by scanning the QR code displayed on the web login page. Here’s how users can log in through QR Login:
+
+1. Open the **MAUI application** and log in.
+2. Navigate to the **Sidebar Menu**.
+3. Select **QR Login** from the menu.
+4. If you haven't granted camera permission before, allow access to the camera.
+5. The QR Code Reader will activate.
+6. Scan the QR code displayed on the web application's login page.
+7. If the QR code is valid, you will be automatically logged in to the web application.
+
+## One-Way Authentication
+QR Login in ASP.NET Zero provides a streamlined authentication flow. It supports one-way authentication, meaning that the user can scan the QR code without entering credentials manually, assuming they are already authenticated in the MAUI app.
+
+![Qr Login Authentication](images/qr-login-authentication.gif)
+
+## Summary
+QR Login provides authentication method for users who are already signed into the MAUI app. By scanning a QR code from the web login page, users can instantly access the web application without entering credentials again. 
+
+## Next
+
+- [Sign Up](Features-Mvc-Core-Sign-Up)
diff --git a/docs/en/Features-Passwordless-Login.md b/docs/en/Features-Passwordless-Login.md
@@ -43,4 +43,8 @@ After filling in the necessary fields according to the chosen verification type,
 
 ![Passwordless login verify passwordless code](images/passwordless-login-verify-passwordless-code.png)
 
-After entering the verification code correctly, user will be authenticated and redirected to the home page of the application.
+After entering the verification code correctly, user will be authenticated and redirected to the home page of the application.
+
+## Next
+
+- [QR Login](Features-Mvc-Core-Qr-Login)
diff --git a/docs/en/images/login-page-with-qr-login.png b/docs/en/images/login-page-with-qr-login.png
diff --git a/docs/en/images/qr-login-authentication.gif b/docs/en/images/qr-login-authentication.gif
diff --git a/docs/en/nav-aspnet-core-angular.json b/docs/en/nav-aspnet-core-angular.json
@@ -177,6 +177,10 @@
                 {
                   "text": "Passwordless Login",
                   "path": "Features-Passwordless-Login.md"
+                },
+                {
+                  "text": "QR Login",
+                  "path": "Features-Angular-Qr-Login.md"
                 }
               ]
             },
diff --git a/docs/en/nav-aspnet-core-mvc.json b/docs/en/nav-aspnet-core-mvc.json
@@ -177,6 +177,10 @@
                 {
                   "text": "Passwordless Login",
                   "path": "Features-Passwordless-Login.md"
+                },
+                {
+                  "text": "QR Login",
+                  "path": "Features-Mvc-Core-Qr-Login.md"
                 }
               ]
             },

Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ Authorization to the header as "Bearer <accessToken>". And the result`
`30`	`30`
`31`	`31`	`## Next`
`32`	`32`
`33`		`-- [Sign Up](Features-Angular-Sign-Up)`
	`33`	`+- [Passwordless Login](Features-Passwordless-Login)`
Original file line number	Diff line number	Diff line change
`@@ -6,5 +6,5 @@ If a user forgets their password, it can be retrieved by clicking the **Forgot P`
`6`	`6`
`7`	`7`	`## Next`
`8`	`8`
`9`		`-- [Sign Up](Features-Mvc-Core-Sign-Up)`
	`9`	`+- [Passwordless Login](Features-Passwordless-Login)`
`10`	`10`
Original file line number	Diff line number	Diff line change
`@@ -177,6 +177,10 @@`
`177`	`177`	`{`
`178`	`178`	`"text": "Passwordless Login",`
`179`	`179`	`"path": "Features-Passwordless-Login.md"`
	`180`	`+ },`
	`181`	`+ {`
	`182`	`+ "text": "QR Login",`
	`183`	`+ "path": "Features-Angular-Qr-Login.md"`
`180`	`184`	`}`
`181`	`185`	`]`
`182`	`186`	`},`