diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index cee3ed7..2a97016 100644 --- a/.github/workflows/gh-pages.yml +++ b/.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 diff --git a/docs/tutorials/features/chat-params.md b/docs/features/chat-params.md similarity index 98% rename from docs/tutorials/features/chat-params.md rename to docs/features/chat-params.md index 3a68faa..46bb508 100644 --- a/docs/tutorials/features/chat-params.md +++ b/docs/features/chat-params.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 3 title: "Chat Parameters" --- diff --git a/docs/tutorials/evaluation/index.mdx b/docs/features/evaluation/index.mdx similarity index 100% rename from docs/tutorials/evaluation/index.mdx rename to docs/features/evaluation/index.mdx diff --git a/docs/tutorials/features/images.md b/docs/features/images.md similarity index 98% rename from docs/tutorials/features/images.md rename to docs/features/images.md index 4c7e9c9..4d9fbbb 100644 --- a/docs/tutorials/features/images.md +++ b/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 diff --git a/docs/features.mdx b/docs/features/index.mdx similarity index 99% rename from docs/features.mdx rename to docs/features/index.mdx index c7708ed..8725350 100644 --- a/docs/features.mdx +++ b/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. diff --git a/docs/tutorials/features/ollama.md b/docs/features/ollama.md similarity index 100% rename from docs/tutorials/features/ollama.md rename to docs/features/ollama.md diff --git a/docs/tutorials/features/openai.md b/docs/features/openai.md similarity index 98% rename from docs/tutorials/features/openai.md rename to docs/features/openai.md index 0e88148..00e87bc 100644 --- a/docs/tutorials/features/openai.md +++ b/docs/features/openai.md @@ -1,5 +1,5 @@ --- -sidebar_position: 2 +sidebar_position: 3 title: "OpenAI Connections" --- diff --git a/docs/tutorials/plugin/functions/actions.md b/docs/features/plugin/functions/actions.md similarity index 100% rename from docs/tutorials/plugin/functions/actions.md rename to docs/features/plugin/functions/actions.md diff --git a/docs/tutorials/plugin/functions/index.mdx b/docs/features/plugin/functions/index.mdx similarity index 100% rename from docs/tutorials/plugin/functions/index.mdx rename to docs/features/plugin/functions/index.mdx diff --git a/docs/tutorials/plugin/index.mdx b/docs/features/plugin/index.mdx similarity index 100% rename from docs/tutorials/plugin/index.mdx rename to docs/features/plugin/index.mdx diff --git a/docs/tutorials/plugin/tools/index.mdx b/docs/features/plugin/tools/index.mdx similarity index 100% rename from docs/tutorials/plugin/tools/index.mdx rename to docs/features/plugin/tools/index.mdx diff --git a/docs/tutorials/features/rag.md b/docs/features/rag.md similarity index 100% rename from docs/tutorials/features/rag.md rename to docs/features/rag.md diff --git a/docs/tutorials/features/sso.md b/docs/features/sso.md similarity index 100% rename from docs/tutorials/features/sso.md rename to docs/features/sso.md diff --git a/docs/tutorials/features/web_search.md b/docs/features/web_search.md similarity index 100% rename from docs/tutorials/features/web_search.md rename to docs/features/web_search.md diff --git a/docs/tutorials/features/whitelist.md b/docs/features/whitelist.md similarity index 100% rename from docs/tutorials/features/whitelist.md rename to docs/features/whitelist.md diff --git a/docs/tutorials/features/workspace/index.mdx b/docs/features/workspace/index.mdx similarity index 100% rename from docs/tutorials/features/workspace/index.mdx rename to docs/features/workspace/index.mdx diff --git a/docs/tutorials/features/workspace/models.md b/docs/features/workspace/models.md similarity index 100% rename from docs/tutorials/features/workspace/models.md rename to docs/features/workspace/models.md diff --git a/docs/getting-started/advanced-topics/env-configuration.md b/docs/getting-started/advanced-topics/env-configuration.md index f3f2905..783df58 100644 --- a/docs/getting-started/advanced-topics/env-configuration.md +++ b/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` diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index db76f08..c83f0cd 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -title: "๐Ÿš€Getting Started" +title: "๐Ÿš€ Getting Started" --- # Getting Started with Open WebUI diff --git a/docs/getting-started/quick-start/tab-python/CondaUnix.md b/docs/getting-started/quick-start/tab-python/CondaUnix.md index 556f9a3..e98db3b 100644 --- a/docs/getting-started/quick-start/tab-python/CondaUnix.md +++ b/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:** diff --git a/docs/getting-started/quick-start/tab-python/CondaWindows.md b/docs/getting-started/quick-start/tab-python/CondaWindows.md index 556f9a3..e98db3b 100644 --- a/docs/getting-started/quick-start/tab-python/CondaWindows.md +++ b/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:** diff --git a/docs/getting-started/using-openwebui/terminology.mdx b/docs/getting-started/using-openwebui/terminology.mdx index 16d8a59..76c8dfa 100644 --- a/docs/getting-started/using-openwebui/terminology.mdx +++ b/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. --- diff --git a/docs/intro.mdx b/docs/intro.mdx index bfa797d..535f019 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -12,7 +12,7 @@ import { SponsorList } from "@site/src/components/SponsorList"; -**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) diff --git a/docs/pipelines/index.mdx b/docs/pipelines/index.mdx index 70db98d..a24b865 100644 --- a/docs/pipelines/index.mdx +++ b/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. diff --git a/docs/tutorials/deployment/index.mdx b/docs/tutorials/deployment/index.mdx index e7a2983..35f71e9 100644 --- a/docs/tutorials/deployment/index.mdx +++ b/docs/tutorials/deployment/index.mdx @@ -6,6 +6,11 @@ import { TopBanners } from "@site/src/components/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! diff --git a/docs/tutorials/features/index.mdx b/docs/tutorials/features/index.mdx deleted file mode 100644 index cd5aac4..0000000 --- a/docs/tutorials/features/index.mdx +++ /dev/null @@ -1,4 +0,0 @@ ---- -sidebar_position: 1 -title: "โœจ Features" ---- \ No newline at end of file diff --git a/docs/tutorials/integrations/apache.md b/docs/tutorials/integrations/apache.md index 9764e28..40c5c4f 100644 --- a/docs/tutorials/integrations/apache.md +++ b/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 diff --git a/docs/tutorials/integrations/browser-search-engine.md b/docs/tutorials/integrations/browser-search-engine.md index 9d890b7..0dd6f32 100644 --- a/docs/tutorials/integrations/browser-search-engine.md +++ b/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. diff --git a/docs/tutorials/integrations/continue-dev.md b/docs/tutorials/integrations/continue-dev.md index 08362e8..d814caa 100644 --- a/docs/tutorials/integrations/continue-dev.md +++ b/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 diff --git a/docs/tutorials/integrations/custom-ca.md b/docs/tutorials/integrations/custom-ca.md index 2b5bf79..80fb821 100644 --- a/docs/tutorials/integrations/custom-ca.md +++ b/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. diff --git a/docs/tutorials/integrations/docker-install.md b/docs/tutorials/integrations/docker-install.md index 3dd3f59..b8fab48 100644 --- a/docs/tutorials/integrations/docker-install.md +++ b/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 diff --git a/docs/tutorials/integrations/ipex_llm.md b/docs/tutorials/integrations/ipex_llm.md index 1828787..0914dc3 100644 --- a/docs/tutorials/integrations/ipex_llm.md +++ b/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). ::: diff --git a/docs/tutorials/integrations/openai-edge-tts-integration.md b/docs/tutorials/integrations/openai-edge-tts-integration.md index 7e254f6..1db790e 100644 --- a/docs/tutorials/integrations/openai-edge-tts-integration.md +++ b/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`? diff --git a/docs/tutorials/integrations/openedai-speech-integration.md b/docs/tutorials/integrations/openedai-speech-integration.md index ea6116a..2656944 100644 --- a/docs/tutorials/integrations/openedai-speech-integration.md +++ b/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** ============================================================== diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 5d670fb..ad581fe 100644 --- a/docusaurus.config.ts +++ b/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 // pathname under which your site is served, defaulting to current value - // For GitHub pages deployment, it is often '//' - baseUrl: process.env.BASE_URL || "/", + // Set the production url of your site here + url: "https://openwebui.com", + // Set the // pathname under which your site is served + // For GitHub pages deployment, it is often '//' + baseUrl: "/", // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these.