forked from phoenix/litellm-mirror
docs(ui.md): update ui docs
This commit is contained in:
parent
f99c056b0d
commit
7bd4737018
2 changed files with 27 additions and 8 deletions
|
@ -2,9 +2,11 @@ import Image from '@theme/IdealImage';
|
||||||
import Tabs from '@theme/Tabs';
|
import Tabs from '@theme/Tabs';
|
||||||
import TabItem from '@theme/TabItem';
|
import TabItem from '@theme/TabItem';
|
||||||
|
|
||||||
# 🔑 [BETA] Admin UI
|
# 🔑 [BETA] Proxy UI
|
||||||
### **Create + delete keys through a UI**
|
### **Create + delete keys through a UI**
|
||||||
|
|
||||||
|
[Let users create their own keys](#setup-ssoauth-for-ui)
|
||||||
|
|
||||||
:::info
|
:::info
|
||||||
|
|
||||||
This is in beta, so things may change. If you have feedback, [let us know](https://discord.com/invite/wuPM9dRgDw)
|
This is in beta, so things may change. If you have feedback, [let us know](https://discord.com/invite/wuPM9dRgDw)
|
||||||
|
@ -40,11 +42,7 @@ Your Proxy Swagger is available on the root of the Proxy: e.g.: `http://localhos
|
||||||
|
|
||||||
<Image img={require('../../img/ui_link.png')} />
|
<Image img={require('../../img/ui_link.png')} />
|
||||||
|
|
||||||
## Setup SSO/Auth for UI
|
## Change default username + password
|
||||||
|
|
||||||
<Tabs>
|
|
||||||
|
|
||||||
<TabItem value="username" label="Quick Start - Username, Password">
|
|
||||||
|
|
||||||
Set the following in your .env on the Proxy
|
Set the following in your .env on the Proxy
|
||||||
|
|
||||||
|
@ -55,8 +53,26 @@ UI_PASSWORD=langchain
|
||||||
|
|
||||||
On accessing the LiteLLM UI, you will be prompted to enter your username, password
|
On accessing the LiteLLM UI, you will be prompted to enter your username, password
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
|
|
||||||
|
## Setup SSO/Auth for UI
|
||||||
|
|
||||||
|
### 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
|
||||||
|
litellm_settings:
|
||||||
|
upperbound_key_generate_params:
|
||||||
|
max_budget: 100 # upperbound of $100, for all /key/generate requests
|
||||||
|
duration: "30d" # upperbound of 30 days for all /key/generate requests
|
||||||
|
```
|
||||||
|
|
||||||
|
** Expected Behavior **
|
||||||
|
|
||||||
|
- 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
|
||||||
|
<Tabs>
|
||||||
<TabItem value="google" label="Google SSO">
|
<TabItem value="google" label="Google SSO">
|
||||||
|
|
||||||
- Create a new Oauth 2.0 Client on https://console.cloud.google.com/
|
- Create a new Oauth 2.0 Client on https://console.cloud.google.com/
|
||||||
|
@ -97,7 +113,10 @@ MICROSOFT_TENANT="5a39737
|
||||||
|
|
||||||
</Tabs>
|
</Tabs>
|
||||||
|
|
||||||
## See Admin view w/ SSO
|
### Step 3. Test flow
|
||||||
|
<Image img={require('../../img/litellm_ui_3.gif')} />
|
||||||
|
|
||||||
|
## Set Admin view w/ SSO
|
||||||
|
|
||||||
You just need to set Proxy Admin ID
|
You just need to set Proxy Admin ID
|
||||||
|
|
||||||
|
|
BIN
docs/my-website/img/litellm_ui_3.gif
Normal file
BIN
docs/my-website/img/litellm_ui_3.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 7.5 MiB |
Loading…
Add table
Add a link
Reference in a new issue