[Docs] UI - Guide on how to set logo

[ishaan-jaff]

[Docs] UI - Guide on how to set logo

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

• I have Added testing in the tests/test_litellm/ directory, Adding at least 1 test is a hard requirement - see details
• My PR passes all unit tests on make test-unit
• My PR's scope is as isolated as possible, it only solves 1 specific problem
• I have requested a Greptile review by commenting @greptileai and received a Confidence Score of at least 4/5 before requesting a maintainer review

CI (LiteLLM team)

CI status guideline:

• 50-55 passing tests: main is stable with minor issues.
• 45-49 passing tests: acceptable but needs attention
• <= 40 passing tests: unstable; be careful with your merges and assess the risk.

• Branch creation CI run
  Link:

• CI run for the last commit
  Link:

• Merge / cherry-pick CI run
  Links:

Type

🆕 New Feature
🐛 Bug Fix
🧹 Refactoring
📖 Documentation
🚄 Infrastructure
✅ Test

Changes

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
litellm	Building	Preview, Comment	Mar 13, 2026 3:44pm

[greptile-apps]

Greptile Summary

This PR adds a new documentation page (ui_edit_logo.md) that guides users through customizing the LiteLLM dashboard logo and favicon via the UI, the REST API, and proxy_config.yaml, and registers the page in the sidebar under Admin UI → Setup & SSO.

Key findings:

• Missing prerequisite warning: The API section documents PATCH /settings/update/ui_theme_settings without noting that STORE_MODEL_IN_DB=True must be set — the endpoint returns a 500 error without it, which will block users following the guide.
• Unused import: import Image from '@theme/IdealImage' is present at the top of the file but never used; all images use plain markdown syntax.
• Incorrect keyboard shortcut: Step 7 instructs users to press Cmd + Left to switch browser tabs, but that shortcut moves the text cursor to the start of a line; Cmd + [ or clicking the tab is the correct approach.
• Incomplete env var example: The proxy_config.yaml environment variables snippet only shows UI_LOGO_PATH but omits LITELLM_FAVICON_URL, which is the actual env var used for the favicon.

Confidence Score: 3/5

• Safe to merge after fixing the missing STORE_MODEL_IN_DB prerequisite note and minor documentation inaccuracies.
• The change is documentation-only with no production code impact. However, the missing STORE_MODEL_IN_DB prerequisite in the API section will actively mislead users into hitting a 500 error, and the incorrect keyboard shortcut and missing LITELLM_FAVICON_URL env var reduce the guide's accuracy and usefulness.
• docs/my-website/docs/proxy/ui/ui_edit_logo.md requires attention for the missing API prerequisite, unused import, incorrect shortcut, and incomplete env var example.

Important Files Changed

Filename	Overview
docs/my-website/docs/proxy/ui/ui_edit_logo.md	New documentation page for customizing the UI logo. Contains an unused import, a missing critical prerequisite (STORE_MODEL_IN_DB=True) for the API section, an incorrect keyboard shortcut, and an incomplete environment variables example missing LITELLM_FAVICON_URL.
docs/my-website/sidebars.js	Sidebar entry added for the new ui_edit_logo page under "Setup & SSO". Change is correct and well-placed.

Sequence Diagram

sequenceDiagram
    participant Admin
    participant LiteLLMProxy
    participant Config as proxy_config.yaml / DB

    Note over Admin,Config: Via API (requires STORE_MODEL_IN_DB=True)
    Admin->>LiteLLMProxy: PATCH /settings/update/ui_theme_settings<br/>{logo_url, favicon_url}
    LiteLLMProxy->>Config: Save litellm_settings.ui_theme_config
    LiteLLMProxy->>LiteLLMProxy: Set UI_LOGO_PATH env var
    LiteLLMProxy->>LiteLLMProxy: Set LITELLM_FAVICON_URL env var
    LiteLLMProxy-->>Admin: 200 OK

    Note over Admin,Config: Read theme settings (public endpoint)
    Admin->>LiteLLMProxy: GET /settings/get/ui_theme_settings
    LiteLLMProxy->>Config: Read litellm_settings.ui_theme_config
    LiteLLMProxy-->>Admin: UIThemeSettingsResponse

    Note over Admin,Config: Via proxy_config.yaml
    Admin->>Config: Set litellm_settings.ui_theme_config.logo_url
    Config->>LiteLLMProxy: Loaded on startup → UI_LOGO_PATH env var

Loading

_{Last reviewed commit: 5af05cc}

[greptile-apps]

Unused import

import Image from '@theme/IdealImage'; is imported on line 1 but never used in the file. All screenshots use standard markdown image syntax (![alt](url)), not the <Image /> component. This will likely produce a linting warning in the Docusaurus build.

Suggested change

import Image from '@theme/IdealImage';

(remove the unused import entirely)

[greptile-apps]

Missing STORE_MODEL_IN_DB prerequisite

The PATCH /settings/update/ui_theme_settings endpoint (and consequently all write API examples in this section) will return a 500 error if STORE_MODEL_IN_DB is not set to True. Looking at the implementation in proxy_setting_endpoints.py (lines 806–812):

if store_model_in_db is not True:
    raise HTTPException(
        status_code=500,
        detail={
            "error": "Set `'STORE_MODEL_IN_DB='True'` in your env to enable this feature."
        },
    )

Users following this guide without that env var will get a cryptic 500 error. The prerequisite should be documented before the API examples, for example:

> **Prerequisite:** The `/update/ui_theme_settings` endpoint requires `STORE_MODEL_IN_DB=True` to be set in your environment.

[greptile-apps]

Incorrect keyboard shortcut

"Cmd + Left" moves the cursor to the beginning of a line in text fields — it does not switch browser tabs. The intended shortcut to navigate back in browser history is Cmd + [ (macOS) or simply asking the user to click the tab would be more reliable cross-platform.

Suggested change

	Navigate back to the LiteLLM UI tab (e.g., press **Cmd + Left** or click the tab).
	Navigate back to the LiteLLM UI tab (e.g., press **Cmd + [** or click the tab).

[greptile-apps]

Missing LITELLM_FAVICON_URL environment variable

The environment variables section only documents UI_LOGO_PATH but omits the favicon equivalent. Looking at the implementation, the favicon is stored as LITELLM_FAVICON_URL (see proxy_setting_endpoints.py line 860). The section should include both for completeness:

Suggested change

	Or set it as an environment variable:
	```yaml
	environment_variables:
	UI_LOGO_PATH: "https://example.com/your-company-logo.png"
	```
	Or set them as environment variables:
	```yaml
	environment_variables:
	UI_LOGO_PATH: "https://example.com/your-company-logo.png"
	LITELLM_FAVICON_URL: "https://example.com/your-favicon.ico" # optional