Table of Contents

Branding Reference

Reference information for the App Configuration keys that control User Portal branding and the Agent Portal theme catalog.

Overview

FoundationaLLM stores branding and theme settings in Azure App Configuration:

  • User Portal branding uses one key per setting under FoundationaLLM:Branding:.
  • Agent Portal themes use a manifest key plus one JSON document per theme under FoundationaLLM:AgentPortal:Themes:.

You can change these settings in three ways:

Method Description Best for
Management Portal Platform > Themes page Interactive changes with preview and contrast checks
App Configuration Set the keys directly in Azure App Configuration Deployment automation
REST API Management API FoundationaLLM.Configuration/appConfigurations resources Custom tooling and scripts

User Portal Branding Keys

The defaults below are the values that Set Default on the Themes page restores.

Logo and icons

Setting Key Default
Logo URL FoundationaLLM:Branding:LogoUrl foundationallm-logo-white.svg
Logo Text FoundationaLLM:Branding:LogoText FoundationaLLM
FavIcon URL FoundationaLLM:Branding:FavIconUrl favicon.ico
Agent Icon URL FoundationaLLM:Branding:AgentIconUrl (empty)

URL values can be an absolute URL or a path relative to the portal's public directory. The agent icon can also be a base64 value.

Text

Setting Key Default
Company Name FoundationaLLM:Branding:CompanyName FoundationaLLM
Page Title FoundationaLLM:Branding:PageTitle FoundationaLLM User Portal
Footer Text FoundationaLLM:Branding:FooterText FoundationaLLM © All rights reserved.
No Agents Message FoundationaLLM:Branding:NoAgentsMessage No agents available. Please check with your system administrator for assistance.
Default Agent Welcome Message FoundationaLLM:Branding:DefaultAgentWelcomeMessage Start the conversation using the text box below.

Colors

Setting Key Default
Primary Color FoundationaLLM:Branding:PrimaryColor #131833
Primary Text Color FoundationaLLM:Branding:PrimaryTextColor #fff
Secondary Color FoundationaLLM:Branding:SecondaryColor #334581
Secondary Text Color FoundationaLLM:Branding:SecondaryTextColor #fff
Accent Color FoundationaLLM:Branding:AccentColor #fff
Accent Text Color FoundationaLLM:Branding:AccentTextColor #131833
Background Color FoundationaLLM:Branding:BackgroundColor #fff
Primary Button Background FoundationaLLM:Branding:PrimaryButtonBackgroundColor #5472d4
Primary Button Text FoundationaLLM:Branding:PrimaryButtonTextColor #fff
Secondary Button Background FoundationaLLM:Branding:SecondaryButtonBackgroundColor #70829a
Secondary Button Text FoundationaLLM:Branding:SecondaryButtonTextColor #fff

Mode

Setting Key Default
Kiosk Mode FoundationaLLM:Branding:KioskMode false

Management Portal

Setting Key Default
Management Portal default theme FoundationaLLM:Branding:ManagementPortalDefaultTheme dark when the key is missing

This optional key sets the light/dark mode the Management Portal uses before a user picks one with the theme toggle. Supported values are dark, light, and system. The Management Portal also uses the logo, favicon, and accent and primary button colors from the keys above.

Agent Portal Theme Keys

Key Content
FoundationaLLM:AgentPortal:Themes:Manifest The catalog manifest: schemaVersion, catalogVersion, themeIds, defaultThemeId, allowedThemeIds
FoundationaLLM:AgentPortal:Themes:{ThemeId} One theme document per entry in themeIds. The key suffix is the theme id with its first letter capitalized (for example, theme interwoven uses FoundationaLLM:AgentPortal:Themes:Interwoven).

All keys use content type application/json. Rules enforced by the platform:

  • schemaVersion must be 1.0 in the manifest and in every theme.
  • Theme ids use lowercase letters, digits, ., _, and - (up to 64 characters, starting with a letter or digit).
  • defaultThemeId must be in both themeIds and allowedThemeIds, and allowedThemeIds must be a subset of themeIds.
  • Each theme document must contain schemaVersion, id, name, description, colors, focus, homescreen, sidebar, header, chat, prompt, userControls, completionControls, completionIcon, userWidget, and footer, and no other properties except the optional artifact_package_name and artifact_package_version.

The Agent Portal reads the catalog through the AgentPortal app configuration set (FoundationaLLM.Configuration/appConfigurationSets/AgentPortal). Each user's selected theme is stored in their user profile.

Color Format Support

Colors can be specified as:

  • Hex: #RRGGBB or #RGB (for example #131833 or #fff)
  • RGB: rgb(R, G, B) (for example rgb(19, 24, 51))

Accessibility Guidelines

Standard Minimum contrast ratio
AA 4.5:1
AAA 7:1

On the Themes page, turn on Show contrast information on the User Portal tab to see the ratio and AA/AAA results for each color pair.

Rich Text Fields

Footer Text, No Agents Message, and Default Agent Welcome Message are edited with a rich text editor on the Themes page and stored as HTML.