tiennm99/litellm
1
0
Fork 0
mirror of https://github.com/tiennm99/litellm.git synced 2026-07-11 07:05:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding a small section to the UI docs

Browse Source
This commit is contained in:
yuneng-jiang
2025-11-20 20:31:38 -08:00
parent eb793537cd
commit c845e45a51
1 changed files with 23 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/my-website/docs/proxy/ui.md
+23 -14
View File
@@ -6,32 +6,31 @@ import TabItem from '@theme/TabItem';
Create keys, track spend, add models without worrying about the config / CRUD endpoints.
<Image img={require('../../img/litellm_ui_create_key.png')} />
<Image img={require('../../img/litellm_ui_create_key.png')} />
## Quick Start
- Requires proxy master key to be set
- Requires db connected
- Requires proxy master key to be set
- Requires db connected
Follow [setup](./virtual_keys.md#setup)
### 1. Start the proxy
```bash
litellm --config /path/to/config.yaml
#INFO: Proxy running on http://0.0.0.0:4000
```
### 2. Go to UI
### 2. Go to UI
```bash
http://0.0.0.0:4000/ui # <proxy_base_url>/ui
```
### 3. Get Admin UI Link on Swagger
### 3. Get Admin UI Link on Swagger
Your Proxy Swagger is available on the root of the Proxy: e.g.: `http://localhost:4000/`
<Image img={require('../../img/ui_link.png')} />
@@ -48,9 +47,20 @@ UI_PASSWORD=langchain # password to sign in on UI
On accessing the LiteLLM UI, you will be prompted to enter your username, password
## Invite-other users
### 5. Configure Root Redirect URL
Allow others to create/delete their own keys.
When `DOCS_URL` is set to something other than `"/"`, you can configure where the root path (`/`) redirects to using `ROOT_REDIRECT_URL`:
```shell
DOCS_URL="/docs" # Set docs to a different path
ROOT_REDIRECT_URL="/ui" # Redirect root path (/) to /ui
```
By default, `DOCS_URL` is `"/"`, so this setting is only needed when you've changed `DOCS_URL` to a different path.
## Invite-other users
Allow others to create/delete their own keys.
[**Go Here**](./self_serve.md)
@@ -72,11 +82,10 @@ For information on sharing models and agents, see [AI Hub](./ai_hub.md).
## Disable Admin UI
Set `DISABLE_ADMIN_UI="True"` in your environment to disable the Admin UI.
Useful, if your security team has additional restrictions on UI usage.
Set `DISABLE_ADMIN_UI="True"` in your environment to disable the Admin UI.
Useful, if your security team has additional restrictions on UI usage.
**Expected Response**
<Image img={require('../../img/admin_ui_disabled.png')}/>
<Image img={require('../../img/admin_ui_disabled.png')}/>