From 693c6ec40e46564b81ab68cad9e1b042083c279a Mon Sep 17 00:00:00 2001 From: ishaan-jaff Date: Tue, 30 Jan 2024 15:41:01 -0800 Subject: [PATCH] (docs) ui + sso callbacks --- docs/my-website/docs/proxy/ui.md | 53 +++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 14 deletions(-) diff --git a/docs/my-website/docs/proxy/ui.md b/docs/my-website/docs/proxy/ui.md index faad799df..0a19c427c 100644 --- a/docs/my-website/docs/proxy/ui.md +++ b/docs/my-website/docs/proxy/ui.md @@ -1,4 +1,6 @@ import Image from '@theme/IdealImage'; +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; # [BETA] Admin UI @@ -26,22 +28,15 @@ general_settings: allow_user_auth: true ``` -## 2. Setup Google SSO - Use this to Authenticate Team Members to the UI -- Create an Oauth 2.0 Client - +## 2. Setup SSO/Auth for UI - - Navigate to Google `Credenentials` - - Create a new Oauth client ID - - Set the `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET` in your Proxy .env -- Set Redirect URL on your Oauth 2.0 Client - - Click on your Oauth 2.0 client on https://console.cloud.google.com/ - - Set a redirect url = `/google-callback` - ``` - https://litellm-production-7002.up.railway.app/google-callback - ``` - -## 3. Required env variables on your Proxy + + + +- Create a new Oauth 2.0 Client on https://console.cloud.google.com/ + +**Required .env variables on your Proxy** ```shell PROXY_BASE_URL="" example PROXY_BASE_URL=https://litellm-production-7002.up.railway.app/ @@ -50,6 +45,36 @@ GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= ``` +- Set Redirect URL on your Oauth 2.0 Client on https://console.cloud.google.com/ + - Set a redirect url = `/sso/callback` + ```shell + https://litellm-production-7002.up.railway.app/sso/callback + ``` + + + + + +- Create a new App Registration on https://portal.azure.com/ +- Create a client Secret for your App Registration + +**Required .env variables on your Proxy** +```shell +PROXY_BASE_URL="" example PROXY_BASE_URL=https://litellm-production-7002.up.railway.app/ + +MICROSOFT_CLIENT_ID="84583a4d-" +MICROSOFT_CLIENT_SECRET="nbk8Q~" +MICROSOFT_TENANT="5a39737 +``` +- Set Redirect URI on your App Registration on https://portal.azure.com/ + - Set a redirect url = `/sso/callback` + ```shell + http://localhost:4000/sso/callback + ``` + + + + ## 4. Use UI 👉 Get Started here: https://litellm-dashboard.vercel.app/