diff --git a/README.md b/README.md index 1094a9b2a..9ec853d54 100644 --- a/README.md +++ b/README.md @@ -171,6 +171,8 @@ The demo, which uses containers pre-built from the main branch is available by c [![Deploy to Azure](https://aka.ms/deploytoazurebutton)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FAzure-Samples%2Fchat-with-your-data-solution-accelerator%2Fmain%2Finfra%2Fmain.json) +When Deployment is complete, follow steps in [Set Up Authentication in Azure App Service](./docs/azure_app_service_auth_setup.md) to add app authentication to your web app running on Azure App Service + **Note**: The default configuration deploys an OpenAI Model "gpt-35-turbo" with version 0613. However, not all locations support this version. If you're deploying to a location that doesn't support version 0613, you'll need to switch to a lower version. To find out which versions are supported in different regions, visit the diff --git a/docs/azure_app_service_auth_setup.md b/docs/azure_app_service_auth_setup.md new file mode 100644 index 000000000..bd3101dd9 --- /dev/null +++ b/docs/azure_app_service_auth_setup.md @@ -0,0 +1,58 @@ +# Set Up Authentication in Azure App Service + +## Step 1: Add Authentication in Azure App Service configuration + +1. Click on `Authentication` from left menu. + +![Authentication](images/AppAuthentication.png) + +2. Click on `+ Add Provider` to see a list of identity providers. + +![Authentication Identity](images/AppAuthenticationIdentity.png) + +3. Click on `+ Add Provider` to see a list of identity providers. + +![Add Provider](images/AppAuthIdentityProvider.png) + +4. Select the first option `Microsoft Entra Id` from the drop-down list. If `Create new app registration` is disabled, go to [Step 1a](#step-1a-creating-a-new-app-registration). + +![Add Provider](images/AppAuthIdentityProviderAdd.png) + +5. Accept the default values and click on `Add` button to go back to the previous page with the identify provider added. + +![Add Provider](images/AppAuthIdentityProviderAdded.png) + +### Step 1a: Creating a new App Registration + +1. Click on `Home` and select `Microsoft Entra ID`. + +![Microsoft Entra ID](images/MicrosoftEntraID.png) + +2. Click on `App registrations`. + +![App registrations](images/Appregistrations.png) + +3. Click on `+ New registration`. + +![New Registrations](images/NewRegistration.png) + +4. Provide the `Name`, select supported account types as `Accounts in this organizational directory only(Contoso only - Single tenant)`, select platform as `Web`, enter/select the `URL` and register. + +![Add Details](images/AddDetails.png) + +5. After application is created sucessfully, then click on `Add a Redirect URL`. + +![Redirect URL](images/AddRedirectURL.png) + +6. Click on `+ Add a platform`. + +![+ Add platform](images/AddPlatform.png) + +7. Click on `Web`. + +![Web](images/Web.png) + +8. Enter the `web app URL` (Provide the app service name in place of XXXX) and Save. Then go back to [Step 1](#step-1-add-authentication-in-azure-app-service-configuration) and follow from _Point 4_ choose `Pick an existing app registration in this directory` from the Add an Identity Provider page and provide the newly registered App Name. +E.g. https://appservicename.azurewebsites.net/.auth/login/aad/callback + +![Add Details](images/WebAppURL.png) diff --git a/docs/images/AddDetails.png b/docs/images/AddDetails.png new file mode 100644 index 000000000..f36b596f2 Binary files /dev/null and b/docs/images/AddDetails.png differ diff --git a/docs/images/AddPlatform.png b/docs/images/AddPlatform.png new file mode 100644 index 000000000..6c74919b4 Binary files /dev/null and b/docs/images/AddPlatform.png differ diff --git a/docs/images/AddRedirectURL.png b/docs/images/AddRedirectURL.png new file mode 100644 index 000000000..d5cbcfac4 Binary files /dev/null and b/docs/images/AddRedirectURL.png differ diff --git a/docs/images/Appregistrations.png b/docs/images/Appregistrations.png new file mode 100644 index 000000000..af2d3ae44 Binary files /dev/null and b/docs/images/Appregistrations.png differ diff --git a/docs/images/MicrosoftEntraID.png b/docs/images/MicrosoftEntraID.png new file mode 100644 index 000000000..1f24b89d0 Binary files /dev/null and b/docs/images/MicrosoftEntraID.png differ diff --git a/docs/images/NewRegistration.png b/docs/images/NewRegistration.png new file mode 100644 index 000000000..288f9af5a Binary files /dev/null and b/docs/images/NewRegistration.png differ diff --git a/docs/images/Web.png b/docs/images/Web.png new file mode 100644 index 000000000..35f846453 Binary files /dev/null and b/docs/images/Web.png differ diff --git a/docs/images/WebAppURL.png b/docs/images/WebAppURL.png new file mode 100644 index 000000000..40c6740e9 Binary files /dev/null and b/docs/images/WebAppURL.png differ