Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed the link in the quickstart docs that point to github that failing on docs.foundationallm.ai #1222

Merged
merged 10 commits into from
Jul 11, 2024
Merged

Fixed the link in the quickstart docs that point to github that failing on docs.foundationallm.ai #1222

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1a518a4
Docs - Updated app-configuration-values with Gatekeeper settings
TheTrainingBoss Jun 10, 2024
5e77ff1
docs - update app-configuration-values with Gatekeeper Settings
TheTrainingBoss Jun 10, 2024
3bc8f3b
docs - app configuration values with GateKeepers changes
TheTrainingBoss Jun 10, 2024
e12a885
Fix #18003 for Docs
TheTrainingBoss Jun 17, 2024
f6c88f7
Documentation for Branding
TheTrainingBoss Jun 29, 2024
c41e51d
Docs update for Branding
TheTrainingBoss Jun 29, 2024
040311a
Branding Docs update
TheTrainingBoss Jun 29, 2024
441637b
Branding Docs changes
TheTrainingBoss Jun 29, 2024
89a3a84
Fix a link in docs for a ps1 file to put back to Hithub
TheTrainingBoss Jul 10, 2024
ea72fb2
Fixed the docfx.json file and fixed the namespaces in the src for Aut…
TheTrainingBoss Jul 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions docs/deployment/app-configuration-values.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,14 @@ FoundationaLLM uses Azure App Configuration to store configuration values, Key V
| `FoundationaLLM:APIs:PromptHubAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. |
| `FoundationaLLM:APIs:SemanticKernelAPI:APIKey` | Key Vault secret name: `foundationallm-apis-semantickernelapi-apikey` | This is a Key Vault reference. |
| `FoundationaLLM:APIs:SemanticKernelAPI:APIUrl` | Enter the URL to the service. | |
| `FoundationaLLM:APIs:SemanticKernelAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference. |
| `FoundationaLLM:APIs:SemanticKernelAPI:ForceHttpsRedirection` | false | |
| `FoundationaLLM:LakeraGuard:APIKey` | Key Vault secret name: `foundationallm-lakeraguard-apikey` | This is a Key Vault reference. |
| `FoundationaLLM:LakeraGuard:APIUrl` | Enter the URL to the service. | |
| `FoundationaLLM:EnkryptGuardrails:APIKey` | Key Vault secret name: `foundationallm-enkryptguardrails-apikey` | This is a Key Vault reference. |
| `FoundationaLLM:EnkryptGuardrails:APIUrl` | Enter the URL to the service. |
| `FoundationaLLM:AzureContentSafety:APIKey` | Key Vault secret name: `foundationallm-azurecontentsafety-apikey` | This is a Key Vault reference. |
| `FoundationaLLM:AzureContentSafety:APIUrl` | Enter the URL to the service. | |
| `FoundationaLLM:AzureContentSafety:HateSeverity` | 2 | |
| `FoundationaLLM:AzureContentSafety:SelfHarmSeverity` | 2 | |
| `FoundationaLLM:AzureContentSafety:SexualSeverity` | 2 | |
| `FoundationaLLM:AzureContentSafety:ViolenceSeverity` | 2 | |
| `FoundationaLLM:APIs:SemanticKernelAPI:AppInsightsConnectionString` | Key Vault secret name: `foundationallm-app-insights-connection-string` | This is a Key Vault reference.|
| `FoundationaLLM:APIs:SemanticKernelAPI:ForceHttpsRedirection` | false | |
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:APIKey` | Key Vault secret name:`foundationallm-apis-gatekeeper-azurecontentsafety-apikey` | This is a Key Vault reference.|
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:APIUrl` | Enter the URL to the service. | |
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:HateSeverity` | 2 | |
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:SelfHarmSeverity` | 2 | |
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:SexualSeverity` | 2 | |
| `FoundationaLLM:APIs:Gatekeeper:AzureContentSafety:ViolenceSeverity` | 2 | |
| `FoundationaLLM:AzureOpenAI:API:Completions:DeploymentName` | completions | |
| `FoundationaLLM:AzureOpenAI:API:Completions:MaxTokens` | 8096 | |
| `FoundationaLLM:AzureOpenAI:API:Completions:ModelName` | gpt-35-turbo | |
Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/deployment-quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ So for deployment purposes, it is recommended to use the latest release branch,
## Deployment steps

Follow the steps below to deploy the solution to your Azure subscription.
If you are upgrading from a previous version, like `0.5.0`, please refer to the changes in the [release notes](changes-060.md).
If you are upgrading from a previous version, like `0.5.0`, please refer to the changes in the [breaking changes notes](../release-notes/breaking-changes.md).

> [!IMPORTANT]
> Follow the instructions in the [Authentication and Authorization setup document](authentication-authorization/index.md) to finalize authentication and authorization for the solution. Bear in mind that creating the app registrations in the Entra ID tenant is a **prerequisite** for the deployment, but you will have to revisit some of these settings after the deployment is complete later to fill in some missing values that are generated during the deployment.
Expand Down Expand Up @@ -141,7 +141,7 @@ If you are upgrading from a previous version, like `0.5.0`, please refer to the

### Running script to allow MS Graph access through Role Permissions

After the deployment is complete, you will need to run the following script to allow MS Graph access through Role Permissions. [Role Permissions Script](/deploy/common/scripts/Assign-MSGraph-Roles.ps1)
After the deployment is complete, you will need to run the following script to allow MS Graph access through Role Permissions. [Role Permissions Script](https://github.com/solliancenet/foundationallm/blob/main/deploy/common/scripts/Assign-MSGraph-Roles.ps1)
This script will need to be executed twice for the principal IDs of the following:
- Core API Managed Identity
- Management API Managed Identity
Expand Down
2 changes: 1 addition & 1 deletion docs/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
{
"files": [
"api/dotnet/**.yml",
"api/dotnet/README.md"
"api/dotnet/index.md"
]
},
{
Expand Down
72 changes: 72 additions & 0 deletions docs/setup-guides/branding/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
# Branding Customization

The `FoundationaLLM` application provides a way to customize the branding of the application. The branding customization can be done by setting any of the **18 configuration values** available in the `App Configuration` resource in your Azure Resource Group. It can also be changed using the REST API calls pertaining to Branding.

### Accessing the App Configuration for branding customization

In your Azure Resource Group, navigate to the `App Configuration` resource and select the `Configuration Explorer` option under `Operations`. You will see a list of all configuration settings for `FoundationaLLM `m filter the list on the word `Branding` and you will be able to see the 18 relevant configuration settings pertaining to Branding.

![Branding App Configuration](./media/branding-1.jpg)

### The default User Interface of the `FoundationaLLM` is shown below

![Branding defaultn](./media/branding-2.jpg)

### The Login screen can also be customized as shown below

![Branding Login Page](./media/branding-3.jpg)

### The chat window can be customized as shown below

![Branding Chat Page](./media/branding-4.jpg)

## FoundationaLLM:Branding:AccentColor
Takes a hexadecimal color value to set the accent color of the chat application which is used for top header and the the token counter in the chat.
## FoundationaLLM:Branding:AccentTextColor
Takes a hexadecimal color value to set the accent text color of the chat application which is used for top header and the the token counter in the chat.
## FoundationaLLM:Branding:BackgroundColor
Takes a hexadecimal color value to set the background color of the chat application.
## FoundationaLLM:Branding:CompanyName
Not is use. Reserved for future enhancements.

## FoundationaLLM:Branding:FavIconUrl
A string value to set the FavIcon Url which is displayed in the browser tab.
> [!IMPORTANT]
> The FavIconUrl can be an SVG or PNG image placed in the Public folder of the application's source code but will require rebuilding of the docker image to reflect the changes. The preferred way of setting the FavIconUrl is to set it to a relative accessible public URL to an SVG or PNG image.

> [!IMPORTANT]
> Any changes to the `FoundationaLLM:Branding:FavIconUrl` will require a restart of the `CoreAPI` image to take effect.

## FoundationaLLM:Branding:FooterText
A string value to set the Footer Text value which is displayed at the bottom right of the screen.
## FoundationaLLM:Branding:KioskMode
This is a boolean flag to indicate if the application is running in kiosk mode, if true will remove the sessions panel on the left navigation panel.
## FoundationaLLM:Branding:LogoText
A string value to set the Logo Text value which is displayed only if the `FoundationaLLM:Branding:LogoUrl` is not set.
## FoundationaLLM:Branding:LogoUrl
A string value to set the Logo Url which is displayed in top left header and also in the login screen.
> [!IMPORTANT]
> The LogoUrl can be an SVG or PNG image placed in the Public folder of the application's source code but will require rebuilding of the docker image to reflect the changes. The preferred way of setting the LogoUrl is to set it to a relative accessible public URL to an SVG or PNG image.
## FoundationaLLM:Branding:PageTitle
A string value to set the Page Title value which is displayed in the browser tab.

![PageTitle](./media/branding-5.jpg)

> [!IMPORTANT]
> Any changes to the `FoundationaLLM:Branding:PageTitle` will require a restart of the `CoreAPI` image to take effect.
## FoundationaLLM:Branding:PrimaryButtonBackgroundColor
Takes a hexadecimal color value to set the Primary Button Background color of the chat application. It affects the `Send` button in the chat at the bottom right, the `Close` button the `View Prompt` screen and the `login` button in the login screen.
## FoundationaLLM:Branding:PrimaryButtonTextColor
Takes a hexadecimal color value to set the Primary Button Text color of the chat application. It affects the `Send` button in the chat at the bottom right, the `Close` button the `View Prompt` screen and the `login` button in the login screen.
## FoundationaLLM:Branding:PrimaryColor
Takes a hexadecimal color value to set the Primary color of the chat application. It affects the left navigation panel and the `User Message` panel in the chat.
## FoundationaLLM:Branding:PrimaryTextColor
Takes a hexadecimal color value to set the Primary Text color of the chat application. It affects the left navigation panel and the `User Message` panel in the chat.
## FoundationaLLM:Branding:SecondaryButtonBackgroundColor
Takes a hexadecimal color value to set the Secondary Button Background color of the chat application. It affects the `collapsable arrow` in the left navigation panel, the `Sign Out` bottom at the bottom and the `attachment` of files button in the chat window.
## FoundationaLLM:Branding:SecondaryButtonTextColor
Takes a hexadecimal color value to set the Secondary Button Text color of the chat application. It affects the `collapsable arrow` in the left navigation panel, the `Sign Out` bottom at the bottom and the `attachment` of files button in the chat window.
## FoundationaLLM:Branding:SecondaryColor
Takes a hexadecimal color value to set the Secondary color of the chat application. It affects the background color of the `session identifier` in the left navigations panel and the background of the entire `login screen`.
## FoundationaLLM:Branding:SecondaryTextColor
Takes a hexadecimal color value to set the Secondary Text color of the chat application. It affects the background color of the `session identifier` in the left navigations panel.
Binary file added docs/setup-guides/branding/media/branding-1.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/setup-guides/branding/media/branding-2.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/setup-guides/branding/media/branding-3.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/setup-guides/branding/media/branding-4.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/setup-guides/branding/media/branding-5.jpg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 1 addition & 2 deletions src/dotnet/AuthorizationAPI/Controllers/AuthorizeController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
using FoundationaLLM.Authorization.Interfaces;
using FoundationaLLM.Common.Models.Authorization;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace AuthorizationAPI.Controllers
namespace FoundationaLLM.Authorization.API.Controllers
{
/// <summary>
/// Provides methods for processing authorization requests.
Expand Down
1 change: 0 additions & 1 deletion src/dotnet/AuthorizationAPI/Controllers/RoleAssignmentsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
using FoundationaLLM.Authorization.Interfaces;
using FoundationaLLM.Common.Models.Authorization;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

Expand Down
5 changes: 1 addition & 4 deletions src/dotnet/AuthorizationAPI/Controllers/StatusController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
using FoundationaLLM.Common.Constants;
using FoundationaLLM.Common.Constants.Configuration;
using FoundationaLLM.Common.Models.Infrastructure;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Authorization;
using Microsoft.AspNetCore.Mvc;

namespace FoundationaLLM.Authorization.API.Controllers
Expand Down
Loading