diff --git a/docs/my-website/docs/proxy/ui.md b/docs/my-website/docs/proxy/ui.md index f6fa02fb69..33033b06f8 100644 --- a/docs/my-website/docs/proxy/ui.md +++ b/docs/my-website/docs/proxy/ui.md @@ -6,32 +6,31 @@ import TabItem from '@theme/TabItem'; Create keys, track spend, add models without worrying about the config / CRUD endpoints. - - - - + ## 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 # /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/` @@ -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** - \ No newline at end of file +