khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2025-12-12 07:29:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

Update onedrive-sharepoint.mdx

Browse Source
This commit is contained in:
Classic298
2025-09-20 16:58:49 +02:00
committed by GitHub
parent f204e43d71
commit 8094c1a550
1 changed files with 62 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
docs/tutorials/integrations/onedrive-sharepoint.mdx
View File

@@ -4,58 +4,49 @@ title: "📁 Integrate with OneDrive & SharePoint"
---
:::info
This tutorial provides a step-by-step guide for integrating Open WebUI with **Microsoft OneDrive for Business and SharePoint**. The instructions are specifically for setting up an organizational (work/school) account.
Due to architectural limitations in the current version, configuring the integration for business use will cause the "Personal OneDrive" option to fail. A technical fix is required to enable both simultaneously.
This tutorial provides a step-by-step guide for integrating Open WebUI with **Microsoft OneDrive for Business & SharePoint**, as well as the separate, optional integration for **Personal Microsoft OneDrive** accounts. You can enable one or both integrations.
:::
---
# Configuring OneDrive for Business & SharePoint Integration
# Configuring OneDrive & SharePoint Integration
This guide will walk you through the entire process of configuring Open WebUI to allow users to attach files directly from their Microsoft OneDrive for Business and associated SharePoint document libraries. This process involves creating an application in the Microsoft Azure portal and setting the correct environment variables in your Open WebUI instance.
This guide will walk you through the entire process of configuring Open WebUI to allow users to attach files directly from their Microsoft accounts. This process involves creating one or two application registrations in the Microsoft Azure portal and setting the correct environment variables in your Open WebUI instance.
## Prerequisites
To successfully complete this tutorial, you will need:
- An active Microsoft Azure account with administrative privileges to create and manage App Registrations in Microsoft Entra ID.
- An active Microsoft Azure account with administrative privileges to create and manage App Registrations.
- Access to your Open WebUI instance's environment variables (e.g., via a `.env` file or Docker environment settings).
# Integration Steps
# Integration for OneDrive for Business & SharePoint (Work/School)
The integration relies on the OAuth 2.0 authorization protocol. You must register an application in your Azure tenant, which will grant Open WebUI the necessary permissions to access files on behalf of your users.
This is the primary integration for organizational use. Follow these steps to allow users to access files from their work or school accounts.
## Step 1: Create an Azure App Registration
## Step 1: Create the Azure App Registration
First, you need to register a new application within your organization's Microsoft Entra ID (formerly Azure AD) tenant.
First, you need to register an application in your organization's Microsoft Entra ID (formerly Azure AD) tenant.
1. Navigate to the [Microsoft Entra ID admin center](https://entra.microsoft.com/).
2. Go to **Identity** > **Applications** > **App registrations**.
3. Select **+ New registration**.
4. Give your application a descriptive name, such as "Open WebUI OneDrive Integration".
5. Under "Supported account types," select **"Accounts in this organizational directory only (Single tenant)"** or **"Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)"** depending on your needs. Do **not** select an option that includes personal Microsoft accounts.
6. Leave the "Redirect URI" section blank for now. We will configure it in the next step.
7. Click **Register**.
4. Give your application a descriptive name, such as "Open WebUI Business Integration".
5. Under "Supported account types," select **"Accounts in this organizational directory only (Single tenant)"** or **"Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)"**.
6. Leave the "Redirect URI" section blank for now. Click **Register**.
## Step 2: Configure the SPA Redirect URI
Open WebUI is a Single-Page Application (SPA) and uses the Microsoft Authentication Library (MSAL) for browsers. It is critical that you configure the Redirect URI correctly for this type of application.
Open WebUI is a Single-Page Application (SPA) and uses the Microsoft Authentication Library (MSAL). It is critical to configure the Redirect URI correctly.
1. From your new App Registration's overview page, go to the **Authentication** tab.
2. Click **+ Add a platform** and select **Single-page application (SPA)**.
3. Under "Redirect URIs", enter the base URL of your Open WebUI instance. For example:
- `http://localhost:3000` (if running locally for testing)
- `https://open-webui.yourdomain.com` (if using a custom domain)
3. Under "Redirect URIs", enter the base URL of your Open WebUI instance (e.g., `https://open-webui.yourdomain.com`).
4. Click **Configure**.
:::info Why an SPA Redirect URI?
Open WebUI's authentication flow is handled client-side. Configuring the redirect URI as an SPA ensures that the MSAL library can correctly handle authentication tokens after a user logs in, even as they navigate between different chat URLs within the application.
:::
## Step 3: Configure API Permissions
Next, you must grant the application permission to read files from OneDrive and SharePoint. The application uses a special `.default` scope, which means it will request all permissions that have been pre-approved by an administrator.
Next, grant the application permission to read files from OneDrive and SharePoint on behalf of your users.
1. From the App Registration menu, go to the **API permissions** tab.
2. Click **+ Add a permission** and select **Microsoft Graph**.
@@ -66,46 +57,74 @@ Next, you must grant the application permission to read files from OneDrive and
5. After adding the permissions, you must grant admin consent. Click the **"Grant admin consent for [Your Tenant Name]"** button. The status for these permissions should change to "Granted".
:::warning Admin Consent is Mandatory
Because Open WebUI is designed for a seamless enterprise experience, it does not prompt each user for consent. If admin consent is not granted here, non-admin users will be blocked from logging in with an "Admin approval required" error.
Open WebUI uses the `.default` scope for a seamless enterprise experience, meaning it relies on pre-approved permissions. If admin consent is not granted here, non-admin users will be blocked from logging in with an "Admin approval required" error.
:::
## Step 4: Gather Required Credentials
## Step 4: Gather Credentials for Business Integration
Now, gather the three pieces of information you will need for your environment variables.
From the **Overview** page of the App Registration you just created, copy the following values:
1. From the **Overview** page of your App Registration, copy the following values:
- **Application (client) ID**: This will be your `ONEDRIVE_CLIENT_ID`.
- **Directory (tenant) ID**: This will be your `ONEDRIVE_SHAREPOINT_TENANT_ID`.
2. You will also need the root URL of your organization's SharePoint instance. It typically follows this format:
- `https://<your-tenant-name>.sharepoint.com`
- **Application (client) ID**: This will be your `ONEDRIVE_CLIENT_ID`.
- **Directory (tenant) ID**: This will be your `ONEDRIVE_SHAREPOINT_TENANT_ID`.
## Step 5: Configure Open WebUI Environment Variables
## Step 5: Configure Environment Variables for Business Integration
Finally, set the following environment variables in your Open WebUI deployment:
Set the following environment variables in your Open WebUI deployment to enable the work/school integration:
```bash
# Enable the OneDrive integration feature
# Enable the OneDrive integration feature globally
ENABLE_ONEDRIVE_INTEGRATION=true
# The Application (client) ID from Step 4
# --- Business & SharePoint Configuration ---
# The Application (client) ID from your Business App Registration
ONEDRIVE_CLIENT_ID="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
# The Directory (tenant) ID from Step 4
# The Directory (tenant) ID from your Business App Registration
ONEDRIVE_SHAREPOINT_TENANT_ID="yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
# The root URL of your SharePoint instance from Step 4
# The root URL of your SharePoint instance
ONEDRIVE_SHAREPOINT_URL="https://your-tenant-name.sharepoint.com"
```
After setting these variables, restart your Open WebUI instance.
---
## Step 6: Verify Integration and Browser Settings
# Integration for Personal OneDrive (Optional)
1. In Open WebUI, open the attachment menu (+) in the chat input. You should see an option for **"Microsoft OneDrive (work/school)"**.
2. Clicking this option should trigger a pop-up window for Microsoft authentication.
To enable support for personal Microsoft accounts, you must create a **second, separate App Registration** configured for consumers.
## Step 1: Create a Separate App Registration for Personal Accounts
1. Navigate back to **App registrations** in Microsoft Entra ID and select **+ New registration**.
2. Give it a distinct name, like "Open WebUI Personal Integration".
3. Under "Supported account types," select the option: **"Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)"**.
4. Configure the **SPA Redirect URI** with your Open WebUI base URL, just as you did for the business app.
5. For this personal registration, no special API permissions or admin consent are required, as users will consent to `OneDrive.ReadWrite` individually.
## Step 2: Gather the Client ID for Personal Integration
From the **Overview** page of this new "Personal" App Registration, copy the **Application (client) ID**. This will be used for a different environment variable.
## Step 3: Configure the Environment Variable for Personal Integration
Add the following environment variable to your Open WebUI deployment:
```bash
# --- Personal Account Configuration (Optional) ---
# The Application (client) ID from your *second*, Personal App Registration
ONEDRIVE_PERSONAL_CLIENT_ID="zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz"
```
---
## Final Step: Browser Configuration and Verification
After setting your environment variables and restarting your Open WebUI instance, verify the integration.
1. In Open WebUI, open the attachment menu (+) in the chat input. You should see menu items for **"Microsoft OneDrive (work/school)"** and/or **"Microsoft OneDrive (personal)"**, depending on your configuration.
2. Clicking either option should trigger a pop-up window for Microsoft authentication.
:::caution Disable Pop-up Blockers!
The OneDrive file picker and authentication flow happen in a pop-up window. If nothing happens when you click the OneDrive option, it is almost certainly because your browser is blocking pop-ups. **You must disable the pop-up blocker for your Open WebUI domain** for the integration to work.
The OneDrive file picker and authentication flow happen in a pop-up window. If nothing happens when you click a OneDrive option, it is almost certainly because your browser is blocking pop-ups. **You must disable the pop-up blocker for your Open WebUI domain** for the integration to work.
:::
You should now be able to authenticate and select files from your OneDrive and SharePoint libraries.
You have now successfully configured OneDrive integration, providing seamless file access for your users.