Merge branch 'open-webui:main' into getting-started-fixes

.github/workflows/gh-pages.yml

@@ -1,58 +1,55 @@
 ---
-    name: Deploy site to Pages
-    
-    on:
-      # Runs on pushes targeting the default branch
-      push:
-        branches: ["main"]
-    
-      # Allows you to run this workflow manually from the Actions tab
-      workflow_dispatch:
-    
-    # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-    
-    # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
-    # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
-    concurrency:
-      group: "pages"
-      cancel-in-progress: false
-    
-    jobs:
-      # Build job
-      build:
-        runs-on: ubuntu-latest
-        steps:
-          - name: Checkout
-            uses: actions/checkout@v4
-          - name: Setup Node
-            uses: actions/setup-node@v4
-            with:
-              node-version-file: ".node-version"
-              cache: npm
-          - name: Install dependencies
-            run: npm ci
-          - name: Build
-            env:
-              BASE_URL: ${{ vars.BASE_URL }}
-              SITE_URL: ${{ vars.SITE_URL }}
-            run: npm run build
-          - name: Upload artifact
-            uses: actions/upload-pages-artifact@v3
-            with:
-              path: ./build
-    
-      # Deployment job
-      deploy:
-        environment:
-          name: github-pages
-          url: ${{ steps.deployment.outputs.page_url }}
-        runs-on: ubuntu-latest
-        needs: build
-        steps:
-          - name: Deploy to GitHub Pages
-            id: deployment
-            uses: actions/deploy-pages@v4
+name: Deploy site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: ".node-version"
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Build
+        run: npm run build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./build
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/features/chat-params.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 3
 title: "Chat Parameters"
 ---
 

docs/features/images.md

@@ -106,7 +106,7 @@ After completing these steps, your ComfyUI setup should be integrated with Open
 
 ### Configuring with SwarmUI
 
-SwarmUI utilizes ComfyUI as its backend. In order to get Open WebUI to work with SwarmUI you will have to append `ComfyBackendDirect` to the `ComfyUI Base URL`. Additionally, you will want to setup SwarmUI with LAN access. After aforementioned adjustments, setting up SwarmUI to work with Open WebUI will be the same as [Step one: Configure Open WebUI Settings](https://github.com/open-webui/docs/edit/main/docs/tutorials/features/images.md#step-1-configure-open-webui-settings) as outlined above. 
+SwarmUI utilizes ComfyUI as its backend. In order to get Open WebUI to work with SwarmUI you will have to append `ComfyBackendDirect` to the `ComfyUI Base URL`. Additionally, you will want to setup SwarmUI with LAN access. After aforementioned adjustments, setting up SwarmUI to work with Open WebUI will be the same as [Step one: Configure Open WebUI Settings](https://github.com/open-webui/docs/edit/main/docs/features/images.md#step-1-configure-open-webui-settings) as outlined above. 
 ![Install SwarmUI with LAN Access](https://github.com/user-attachments/assets/a6567e13-1ced-4743-8d8e-be526207f9f6)
 
 #### SwarmUI API URL

docs/features/index.mdx

@@ -283,7 +283,7 @@ import { TopBanners } from "@site/src/components/TopBanners";
 
 - 🔒 **Backend Reverse Proxy Support**: Bolster security through direct communication between Open WebUI's backend and Ollama. This key feature eliminates the need to expose Ollama over the local area network (LAN). Requests made to the `/ollama/api` route from Open WebUI are seamlessly redirected to Ollama from the backend, enhancing overall system security and providing an additional layer of protection.
 
-- 🔒 **Authentication**: Please note that Open WebUI does not natively support federated authentication schemes such as SSO, OAuth, SAML, or OIDC. However, it can be configured to delegate authentication to an authenticating reverse proxy, effectively achieving a Single Sign-On (`SSO`) experience. This setup allows you to centralize user authentication and management, enhancing security and user convenience. By integrating Open WebUI with an authenticating reverse proxy, you can leverage existing authentication systems and streamline user access to Open WebUI. For more information on configuring this feature, please refer to the [Federated Authentication Support](https://docs.openwebui.com/tutorials/features/sso).
+- 🔒 **Authentication**: Please note that Open WebUI does not natively support federated authentication schemes such as SSO, OAuth, SAML, or OIDC. However, it can be configured to delegate authentication to an authenticating reverse proxy, effectively achieving a Single Sign-On (`SSO`) experience. This setup allows you to centralize user authentication and management, enhancing security and user convenience. By integrating Open WebUI with an authenticating reverse proxy, you can leverage existing authentication systems and streamline user access to Open WebUI. For more information on configuring this feature, please refer to the [Federated Authentication Support](https://docs.openwebui.com/features/sso).
 
 - 🔓 **Optional Authentication**: Enjoy the flexibility of disabling authentication by setting `WEBUI_AUTH` to `False`. This is an ideal solution for fresh installations without existing users or can be useful for demonstration purposes.
 

docs/features/openai.md

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 3
 title: "OpenAI Connections"
 ---
 

docs/getting-started/advanced-topics/env-configuration.md

@@ -210,13 +210,13 @@ is also being used and set to `True`. Failure to do so will result in the inabil
 #### `WEBUI_AUTH_TRUSTED_EMAIL_HEADER`
 
 - Type: `str`
-- Description: Defines the trusted request header for authentication. See [SSO docs](/tutorials/features/sso).
+- Description: Defines the trusted request header for authentication. See [SSO docs](/features/sso).
 
 #### `WEBUI_AUTH_TRUSTED_NAME_HEADER`
 
 - Type: `str`
 - Description: Defines the trusted request header for the username of anyone registering with the 
-`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/tutorials/features/sso).
+`WEBUI_AUTH_TRUSTED_EMAIL_HEADER` header. See [SSO docs](/features/sso).
 
 #### `WEBUI_SECRET_KEY`
 

docs/getting-started/index.md

@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-title: "🚀Getting Started"
+title: "🚀 Getting Started"
 ---
 
 # Getting Started with Open WebUI

docs/getting-started/quick-start/tab-python/CondaUnix.md

@@ -5,7 +5,7 @@
 1. **Create a Conda Environment:**
 
    ```bash
-   conda create -n open-webui python=3.9
+   conda create -n open-webui python=3.11
    ```
 
 2. **Activate the Environment:**

docs/getting-started/quick-start/tab-python/CondaWindows.md

@@ -5,7 +5,7 @@
 1. **Create a Conda Environment:**
 
    ```bash
-   conda create -n open-webui python=3.9
+   conda create -n open-webui python=3.11
    ```
 
 2. **Activate the Environment:**

docs/getting-started/using-openwebui/terminology.mdx

@@ -10,7 +10,7 @@ Enhance your understanding of OpenWebUI with key concepts and components to impr
 ---
 
 ## Explore the Workspace  
-Begin by exploring the [Workspace](../../tutorials/features/workspace) to discover essential concepts such as Modelfiles, Knowledge, Prompts, Tools, and Functions.
+Begin by exploring the [Workspace](../../features/workspace) to discover essential concepts such as Modelfiles, Knowledge, Prompts, Tools, and Functions.
 
 ---
 

docs/intro.mdx

@@ -12,7 +12,7 @@ import { SponsorList } from "@site/src/components/SponsorList";
 
 <TopBanners />
 
-**Open WebUI is an [extensible](https://docs.openwebui.com/tutorials/plugin/), feature-rich, and user-friendly self-hosted AI interface designed to operate entirely offline.** It supports various LLM runners, including Ollama and OpenAI-compatible APIs.
+**Open WebUI is an [extensible](https://docs.openwebui.com/features/plugin/), feature-rich, and user-friendly self-hosted AI interface designed to operate entirely offline.** It supports various LLM runners, including Ollama and OpenAI-compatible APIs.
 
 ![GitHub stars](https://img.shields.io/github/stars/open-webui/open-webui?style=social)
 ![GitHub forks](https://img.shields.io/github/forks/open-webui/open-webui?style=social)

docs/pipelines/index.mdx

@@ -12,7 +12,7 @@ title: "⚡ Pipelines"
 # Pipelines: UI-Agnostic OpenAI API Plugin Framework
 
 :::tip
-If your goal is simply to add support for additional providers like Anthropic or basic filters, you likely don't need Pipelines . For those cases, [Open WebUI Functions](/tutorials/plugin/functions) are a better fit—it's built-in, much more convenient, and easier to configure. Pipelines, however, comes into play when you're dealing with computationally heavy tasks (e.g., running large models or complex logic) that you want to offload from your main Open WebUI instance for better performance and scalability.
+If your goal is simply to add support for additional providers like Anthropic or basic filters, you likely don't need Pipelines . For those cases, [Open WebUI Functions](/features/plugin/functions) are a better fit—it's built-in, much more convenient, and easier to configure. Pipelines, however, comes into play when you're dealing with computationally heavy tasks (e.g., running large models or complex logic) that you want to offload from your main Open WebUI instance for better performance and scalability.
 :::
 
 Welcome to **Pipelines**, an [Open WebUI](https://github.com/open-webui) initiative. Pipelines bring modular, customizable workflows to any UI client supporting OpenAI API specs – and much more! Easily extend functionalities, integrate unique logic, and create dynamic workflows with just a few lines of code.

docs/tutorials/deployment/index.mdx

@@ -6,6 +6,11 @@ import { TopBanners } from "@site/src/components/TopBanners";
 
 <TopBanners />
 
+
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
 :::info
 # 📢 **Calling all YouTubers!**
 We're looking for talented individuals to create videos showcasing Open WebUI's features. If you make a video, we'll feature it at the top of our guide section!

docs/tutorials/features/index.mdx

@@ -1,4 +0,0 @@
----
-sidebar_position: 1
-title: "✨ Features"
----

docs/tutorials/integrations/apache.md

@@ -3,6 +3,11 @@ sidebar_position: 7
 title: "Hosting UI and Models separately"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 # Hosting UI and Models separately
 
 :::note

docs/tutorials/integrations/browser-search-engine.md

@@ -3,6 +3,11 @@ sidebar_position: 16
 title: "Browser Search Engine"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 # Browser Search Engine Integration
 
 Open WebUI allows you to integrate directly into your web browser. This tutorial will guide you through the process of setting up Open WebUI as a custom search engine, enabling you to execute queries easily from your browser's address bar.

docs/tutorials/integrations/continue-dev.md

@@ -3,6 +3,12 @@ sidebar_position: 13
 title: "Continue.dev VSCode Extension with Open WebUI"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
+
 # Integrating Continue.dev VSCode Extension with Open WebUI
 
 ### Download Extension

docs/tutorials/integrations/custom-ca.md

@@ -3,6 +3,11 @@ sidebar_position: 14
 title: Setting up with custom CA store
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 If you get an `[SSL: CERTIFICATE_VERIFY_FAILED]` error when trying to run OI, most likely the issue is that you are on a network which intercepts HTTPS traffic (e.g. a corporate network).
 
 To fix this, you will need to add the new cert into OI's truststore.

docs/tutorials/integrations/docker-install.md

@@ -3,6 +3,11 @@ sidebar_position: 2
 title: Installing Docker
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 # Installing Docker
 
 ## For Windows and Mac Users

docs/tutorials/integrations/ipex_llm.md

@@ -3,6 +3,11 @@ sidebar_position: 11
 title: "Local LLM Setup with IPEX-LLM on Intel GPU"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 :::note
 This guide is verified with Open WebUI setup through [Manual Installation](/getting-started/index.md).
 :::

docs/tutorials/integrations/openai-edge-tts-integration.md

@@ -3,6 +3,11 @@ sidebar_position: 18
 title: "Edge TTS"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 # Integrating `openai-edge-tts` 🗣️ with Open WebUI
 
 ## What is `openai-edge-tts`, and how is it different from `openedai-speech`?

docs/tutorials/integrations/openedai-speech-integration.md

@@ -3,6 +3,11 @@ sidebar_position: 12
 title: "TTS - OpenedAI-Speech using Docker"
 ---
 
+:::warning
+This tutorial is a community contribution and is not supported by the OpenWebUI team. It serves only as a demonstration on how to customize OpenWebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
+:::
+
+
 **Integrating `openedai-speech` into Open WebUI using Docker**
 ==============================================================
 

docusaurus.config.ts

@@ -8,11 +8,11 @@ const config: Config = {
 	tagline: "ChatGPT-Style WebUI for LLMs (Formerly Ollama WebUI)",
 	favicon: "img/favicon.png",
 
-	// Set the production url of your site here, defaulting to current value
-	url: process.env.SITE_URL || "https://openwebui.com",
-	// Set the /<baseUrl>/ pathname under which your site is served, defaulting to current value
-		// For GitHub pages deployment, it is often '/<projectName>/'
-	baseUrl: process.env.BASE_URL || "/",
+	// Set the production url of your site here
+	url: "https://openwebui.com",
+	// Set the /<baseUrl>/ pathname under which your site is served
+	// For GitHub pages deployment, it is often '/<projectName>/'
+	baseUrl: "/",
 
 	// GitHub pages deployment config.
 	// If you aren't using GitHub pages, you don't need these.