From dbd947a36660b93fcb251e4e395aa956a9e05628 Mon Sep 17 00:00:00 2001 From: ishaan-jaff Date: Wed, 31 Jan 2024 19:54:04 -0800 Subject: [PATCH] (docs) update proxy ui docs --- docs/my-website/docs/proxy/ui.md | 54 +++++++++++++++++-------------- docs/my-website/img/ui_link.png | Bin 0 -> 70882 bytes 2 files changed, 29 insertions(+), 25 deletions(-) create mode 100644 docs/my-website/img/ui_link.png diff --git a/docs/my-website/docs/proxy/ui.md b/docs/my-website/docs/proxy/ui.md index 6538793c1..d4ae6b66b 100644 --- a/docs/my-website/docs/proxy/ui.md +++ b/docs/my-website/docs/proxy/ui.md @@ -18,31 +18,9 @@ Allow your users to create, view their own keys through a UI ## Quick Start -## 1. Changes to your config.yaml - -Set `allow_user_auth: true` on your config - -```yaml -general_settings: - # other changes - allow_user_auth: true -``` - -## 2. Setup SSO/Auth for UI +## 1. Setup SSO/Auth for UI - - -Set the following in your .env on the Proxy - -```shell -UI_USERNAME=ishaan-litellm -UI_PASSWORD=langchain -``` - -On accessing the LiteLLM UI, you will be prompted to enter your username, password - - @@ -84,13 +62,39 @@ MICROSOFT_TENANT="5a39737 http://localhost:4000/sso/callback ``` + + + +Set the following in your .env on the Proxy + +```shell +PROXY_BASE_URL="" example PROXY_BASE_URL=https://litellm-production-7002.up.railway.app/ + +UI_USERNAME=ishaan-litellm +UI_PASSWORD=langchain +``` + +On accessing the LiteLLM UI, you will be prompted to enter your username, password + -## 4. Use UI +## 2. Start Proxy Server + +```shell +litellm --config proxy_config.yaml --port 4000 + +# start proxy on port 4000 +``` + +## 3. Get Admin UI Link to you on Swagger + +Your Proxy Swagger is available on the root of the Proxy: `http://localhost:4000/` + + + -👉 Get Started here: https://litellm-dashboard.vercel.app/