diff --git a/docs/my-website/docs/proxy/ui.md b/docs/my-website/docs/proxy/ui.md index 1c1931f8f..bf98cb0a6 100644 --- a/docs/my-website/docs/proxy/ui.md +++ b/docs/my-website/docs/proxy/ui.md @@ -53,10 +53,11 @@ UI_PASSWORD=langchain On accessing the LiteLLM UI, you will be prompted to enter your username, password +## ✨ Enterprise Features -## Setup SSO/Auth for UI +### Setup SSO/Auth for UI -### Step 1: Set upperbounds for keys +#### Step 1: Set upperbounds for keys Control the upperbound that users can use for `max_budget`, `budget_duration` or any `key/generate` param per key. ```yaml @@ -71,7 +72,7 @@ litellm_settings: - Send a `/key/generate` request with `max_budget=200` - Key will be created with `max_budget=100` since 100 is the upper bound -### Step 2: Setup Oauth Client +#### Step 2: Setup Oauth Client @@ -147,24 +148,24 @@ GENERIC_SCOPE = "openid profile email" # default scope openid is sometimes not e -### Step 3. Test flow +#### Step 3. Test flow -## Set Admin view w/ SSO +### Set Admin view w/ SSO You just need to set Proxy Admin ID -### Step 1: Copy your ID from the UI +#### Step 1: Copy your ID from the UI -### Step 2: Set it in your .env as the PROXY_ADMIN_ID +#### Step 2: Set it in your .env as the PROXY_ADMIN_ID ```env export PROXY_ADMIN_ID="116544810872468347480" ``` -### Step 3: See all proxy keys +#### Step 3: See all proxy keys @@ -172,4 +173,37 @@ export PROXY_ADMIN_ID="116544810872468347480" If you don't see all your keys this could be due to a cached token. So just re-login and it should work. -::: \ No newline at end of file +::: + +### Custom Branding Admin UI + +Use your companies custom branding on the LiteLLM Admin UI +We allow you to +- Customize the UI Logo +- Customize the UI color scheme + + +#### Usage +- Navigate to [/enterprise/enterprise_ui](https://github.com/BerriAI/litellm/blob/main/enterprise/enterprise_ui/_enterprise_colors.json) +- Inside the `enterprise_ui` directory, rename `_enterprise_colors.json` to `enterprise_colors.json` +- Set your companies custom color scheme in `enterprise_colors.json` +Example contents of `enterprise_colors.json` +Set your colors to any of the following colors: https://www.tremor.so/docs/layout/color-palette#default-colors +```json +{ + "brand": { + "DEFAULT": "teal", + "faint": "teal", + "muted": "teal", + "subtle": "teal", + "emphasis": "teal", + "inverted": "teal" + } +} + +``` + +- Set the path to your custom png/jpg logo as `UI_LOGO_PATH` in your .env +- Deploy LiteLLM Proxy Server + + diff --git a/docs/my-website/img/litellm_custom_ai.png b/docs/my-website/img/litellm_custom_ai.png new file mode 100644 index 000000000..ef843961c Binary files /dev/null and b/docs/my-website/img/litellm_custom_ai.png differ