-
Notifications
You must be signed in to change notification settings - Fork 390
docs: add branding config and disableProviderUpload per-endpoint field #557
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.
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
Open
shqear93
wants to merge
3
commits into
LibreChat-AI:main
Choose a base branch
from
shqear93:feat/whitelabel-branding
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
131 changes: 131 additions & 0 deletions
131
content/docs/configuration/librechat_yaml/object_structure/branding.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| --- | ||
| title: "Branding Object Structure" | ||
| icon: Palette | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| The `branding` object enables white-label customization of LibreChat. It provides runtime control over logos, favicons, browser metadata, and color themes — without requiring source code changes. | ||
|
|
||
| Branding is resolved through the same app-config pipeline as `interface` and `turnstile`, and is delivered to the frontend via the `/api/config` startup payload. | ||
|
|
||
| These are the top-level fields under `branding`: | ||
|
|
||
| - `appLogo` | ||
| - `authLogo` | ||
| - `favicon` | ||
| - `meta` | ||
| - `theme` | ||
|
|
||
| ## Example | ||
|
|
||
| ```yaml filename="librechat.yaml" | ||
| branding: | ||
| appLogo: "/assets/my-logo.svg" | ||
| authLogo: "/assets/my-auth-logo.svg" | ||
| favicon: "/assets/my-favicon.png" | ||
| meta: | ||
| title: "My Chat App" | ||
| description: "Powered by LibreChat" | ||
| themeColor: "#0f766e" | ||
| pwaName: "My Chat App" | ||
| pwaShortName: "ChatApp" | ||
| pwaBackgroundColor: "#ffffff" | ||
| pwaThemeColor: "#0f766e" | ||
| theme: | ||
| light: | ||
| rgb-primary: "15 118 110" | ||
| rgb-accent: "13 148 136" | ||
| rgb-surface-primary: "248 250 252" | ||
| dark: | ||
| rgb-primary: "45 212 191" | ||
| rgb-accent: "20 184 166" | ||
| rgb-surface-primary: "15 23 42" | ||
| ``` | ||
|
|
||
| ## branding | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['branding', 'Object', 'White-label branding configuration. All fields are optional. When omitted, LibreChat defaults apply.'], | ||
| ]} | ||
| /> | ||
|
|
||
| ### appLogo | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['appLogo', 'String', 'Path or URL to the main application logo. Used in the app header and other in-app contexts.', '/assets/logo.svg'], | ||
| ]} | ||
| /> | ||
|
|
||
| ### authLogo | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['authLogo', 'String', 'Path or URL to the logo shown on the login and registration pages. Falls back to `appLogo`, then to the default LibreChat logo.', '/assets/logo.svg'], | ||
| ]} | ||
| /> | ||
|
|
||
| ### favicon | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['favicon', 'String', 'Path or URL to the browser favicon. Replaces the default LibreChat favicon at runtime.', '/assets/favicon-32x32.png'], | ||
| ]} | ||
| /> | ||
|
|
||
| ### meta | ||
|
|
||
| Browser and PWA metadata applied at runtime. | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['title', 'String', 'Sets the browser tab title. Overrides `appTitle` from the top-level config when both are present.', 'My Chat App'], | ||
| ['description', 'String', 'Sets the `<meta name="description">` tag content.', 'Powered by LibreChat'], | ||
| ['themeColor', 'String', 'Sets the `<meta name="theme-color">` tag. Controls the browser chrome color on mobile devices.', '#0f766e'], | ||
| ['pwaName', 'String', 'Full name of the app when installed as a Progressive Web App.', 'My Chat App'], | ||
| ['pwaShortName', 'String', 'Short name shown on the home screen when installed as a PWA.', 'ChatApp'], | ||
| ['pwaBackgroundColor', 'String', 'Background color of the PWA splash screen.', '#ffffff'], | ||
| ['pwaThemeColor', 'String', 'Theme color for the PWA shell.', '#0f766e'], | ||
| ]} | ||
| /> | ||
|
|
||
| ### theme | ||
|
|
||
| Runtime color theme tokens injected into the `ThemeProvider`. Supports separate palettes for `light` and `dark` modes. Both are optional — if only one is provided, it is used for both modes. | ||
|
|
||
| Each palette is a map of CSS variable names (without the `--` prefix) to RGB values as space-separated strings (e.g. `"15 118 110"` for `rgb(15, 118, 110)`). | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['light', 'Object', 'Color tokens applied in light mode. Keys are CSS variable names; values are space-separated RGB triplets.'], | ||
| ['dark', 'Object', 'Color tokens applied in dark mode. Keys are CSS variable names; values are space-separated RGB triplets.'], | ||
| ]} | ||
| /> | ||
|
|
||
| **Common theme tokens:** | ||
|
|
||
| <OptionTable | ||
| options={[ | ||
| ['rgb-primary', 'String', 'Primary brand color used for buttons, links, and focus rings.', '"15 118 110"'], | ||
| ['rgb-accent', 'String', 'Accent color used for highlights and hover states.', '"13 148 136"'], | ||
| ['rgb-surface-primary', 'String', 'Main background surface color.', '"248 250 252"'], | ||
| ['rgb-surface-secondary', 'String', 'Secondary surface color for panels and cards.', '"226 232 240"'], | ||
| ['rgb-surface-hover', 'String', 'Surface color on hover.', '"203 213 225"'], | ||
| ['rgb-text-primary', 'String', 'Primary text color.', '"15 23 42"'], | ||
| ['rgb-text-secondary', 'String', 'Secondary/muted text color.', '"51 65 85"'], | ||
| ['rgb-border-light', 'String', 'Light border color.', '"203 213 225"'], | ||
| ['rgb-border-medium', 'String', 'Medium border color.', '"148 163 184"'], | ||
| ['rgb-ring-primary', 'String', 'Focus ring color.', '"15 118 110"'], | ||
| ]} | ||
| /> | ||
|
|
||
| --- | ||
|
|
||
| ## Notes | ||
|
|
||
| - All `branding` fields are optional. Omitting the block entirely leaves default LibreChat behavior unchanged. | ||
| - Logo and favicon paths should be relative to the app's public assets directory or absolute URLs. | ||
| - Theme tokens are applied after the user's theme preference (light/dark) is resolved. The correct palette is selected automatically. | ||
| - The `meta.title` field takes precedence over the top-level `appTitle` config field when both are set. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -651,3 +651,4 @@ interface: | |
| marketplace: | ||
| use: true # Enable marketplace access | ||
| ``` | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
defaultfallback claim to non-assistants endpointsThis note says
defaultapplies to all endpoints without their own entry, but the same page already documents that theassistantsendpoint does not usedefaultsettings. As written, operators can setdisableProviderUploadunderdefaultexpecting Assistants to inherit it, and then ship a config that leaves provider uploads enabled for Assistants unexpectedly.Useful? React with 👍 / 👎.