From 16feac98b7946feded53f2d414860e732be60b8d Mon Sep 17 00:00:00 2001 From: silentoplayz Date: Sat, 22 Nov 2025 01:52:44 -0500 Subject: [PATCH 01/12] docs: Overhaul Deployment page Replaces the existing "Deployment" index.mdx page with a new version that features an improved layout and updated content. This change introduces a cleaner, more organized page for community-submitted guides and videos. It includes a dedicated video gallery using a CSS grid for better presentation and a call to action for content creators. --- docs/tutorials/deployment/index.mdx | 214 +++++++++------------------- 1 file changed, 67 insertions(+), 147 deletions(-) diff --git a/docs/tutorials/deployment/index.mdx b/docs/tutorials/deployment/index.mdx index 147ac7d..6d25ec9 100644 --- a/docs/tutorials/deployment/index.mdx +++ b/docs/tutorials/deployment/index.mdx @@ -1,178 +1,98 @@ --- sidebar_position: 1000 -title: "Deployment" +title: "Deployment & Community Guides" --- + import { TopBanners } from "@site/src/components/TopBanners"; -:::warning - -This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial. - +:::warning Community Content +The tutorials and videos below are created by the community and are not officially supported by the Open WebUI team. They serve as demonstrations for customizing and deploying Open WebUI for specific use cases. ::: -:::info +## 📝 Written Guides -# 📢 **Calling all YouTubers and Content Creators!** -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! +Step-by-step articles for advanced deployment scenarios. +* **Secure HTTPS Deployment** + * [Deploy Your Own Open WebUI Interface with HTTPS Security](https://henrynavarro.org/deploy-your-own-open-webui-interface-with-https-security-53a6ea2609d7?sk=a5876acd56b44ea60f10f9b13aa24aee) — *via Medium (@hdnh2006)* +* **Google Drive Integration** + * [How to integrate Google Drive with Open WebUI](https://henrynavarro.org/how-to-integrate-google-drive-with-open-webui-e525c8f3f82e?sk=a9f48cd1590e3e8dca052f7fe9f12765) — *via Medium (@hdnh2006)* + +
+ +:::info 📹 Content Creators Wanted! +**Are you a YouTuber or Blogger?** +We are looking for talented individuals to create content showcasing Open WebUI's features. If you make a high-quality video or guide, let us know and we'll feature it here! ::: -## Articles +--- -- Learn how to deploy Open WebUI 100% secure through https: [Deploy Your Own Open WebUI Interface with HTTPS Security](https://henrynavarro.org/deploy-your-own-open-webui-interface-with-https-security-53a6ea2609d7?sk=a5876acd56b44ea60f10f9b13aa24aee) (Medium article by @hdnh2006) +## 📺 Video Gallery -- Google Drive integration in Open WebUI interface tutorial: [How to integrate Google Drive with Open WebUI](https://henrynavarro.org/how-to-integrate-google-drive-with-open-webui-e525c8f3f82e?sk=a9f48cd1590e3e8dca052f7fe9f12765) (Medium article by @hdnh2006) +A collection of community installation guides, reviews, and deployment tutorials. -## Videos +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
- +
+ +
+ +
\ No newline at end of file From 672a98d05887172b87159c3a40039f877a554d07 Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Sun, 23 Nov 2025 23:09:44 -0500 Subject: [PATCH 02/12] Update mcp.mdx --- docs/features/mcp.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/features/mcp.mdx b/docs/features/mcp.mdx index 9c1ffad..5e18c55 100644 --- a/docs/features/mcp.mdx +++ b/docs/features/mcp.mdx @@ -47,6 +47,7 @@ Browser-based, multi-user deployments increase the surface area (CORS/CSRF, per- ## ❓ FAQ **Do you support stdio or SSE transports?** + Native MCP support in Open WebUI is **Streamable HTTP only**. This design choice reflects our architecture: Open WebUI is a **web-based, multi-tenant environment**, not a local desktop process. Browsers operate within strict **sandboxed and event-driven HTTP constraints**, making long-lived stdio or SSE connections difficult to maintain securely across users and sessions. @@ -54,7 +55,9 @@ Browsers operate within strict **sandboxed and event-driven HTTP constraints**, If you need to bridge those other MCP transports, check out [**mcpo**](https://github.com/open-webui/mcpo) — an open-source proxy that translates **stdio or SSE-based MCP servers into OpenAPI-compatible endpoints**. It effectively lets you run traditional MCP tools inside Open WebUI without modifying their transport layer. **Is MCP considered stable here?** + Supported and improving. The broader ecosystem is still evolving; expect occasional breaking changes. **Can I mix OpenAPI and MCP tools?** + Yes. Many deployments do both. \ No newline at end of file From e6e00efc8e4d18d3b00e9b50db18af34c9bee7bd Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Sun, 23 Nov 2025 23:10:02 -0500 Subject: [PATCH 03/12] Update mcp.mdx --- docs/features/mcp.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/features/mcp.mdx b/docs/features/mcp.mdx index 5e18c55..6ca6d5e 100644 --- a/docs/features/mcp.mdx +++ b/docs/features/mcp.mdx @@ -5,8 +5,6 @@ sidebar_position: 1200 Open WebUI natively supports **MCP (Model Context Protocol)** starting in **v0.6.31**. This page shows how to enable it quickly, harden it for production, and troubleshoot common snags. -> **Audience:** admins and power users configuring external tools - :::info Requires **Open WebUI v0.6.31+**. ::: From 1f3124525ed843c959e3764645d383f2c35025eb Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Mon, 24 Nov 2025 04:47:00 -0500 Subject: [PATCH 04/12] Update team.mdx --- docs/team.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/team.mdx b/docs/team.mdx index 186c3a3..fefd93f 100644 --- a/docs/team.mdx +++ b/docs/team.mdx @@ -17,7 +17,7 @@ Passionate about open-source AI? [Join our team →](https://careers.openwebui.c ::: -Our team is led by the dedicated creator and founder, [Tim J. Baek](https://github.com/tjbck). Although Tim is currently the only official full-time member of the core development team, we’re also supported by talented team members from our company who work hard behind the scenes to make this project great. In addition, we are incredibly fortunate to have a community of **[amazing contributors](https://github.com/open-webui/open-webui/graphs/contributors)** who find this project valuable and actively participate in its continued success. +Our team is led by the dedicated creator and founder, [Tim J. Baek](https://github.com/tjbck). We’re supported by talented team members from our company who work hard behind the scenes to make this project great. In addition, we are incredibly fortunate to have a community of **[amazing contributors](https://github.com/open-webui/open-webui/graphs/contributors)** who find this project valuable and actively participate in its continued success. ### 💓 Our Contributors From 5adf72e0ecc801f06d4642063aba15ba33545d5e Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Mon, 24 Nov 2025 04:47:47 -0500 Subject: [PATCH 05/12] Update team.mdx --- docs/team.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/team.mdx b/docs/team.mdx index fefd93f..457195d 100644 --- a/docs/team.mdx +++ b/docs/team.mdx @@ -38,7 +38,5 @@ Beyond our contributors, Open WebUI, Inc. has an incredible global team working We greatly appreciate enthusiasm and thoughtful suggestions from our community. At the same time, **we're not looking for unsolicited governance recommendations or guidance on how to operate**—we know exactly how we want to run our project (just as, for example, you wouldn't tell OpenAI how to run theirs). Open WebUI maintains strong, opinionated leadership because that's precisely what we believe is necessary to build something truly great, fast-moving, and purposeful. -If our leadership and governance style align with your views, we're thrilled to have your continued support and contributions. However, if you fundamentally disagree with our direction, **one of the key benefits of our open-source license is the freedom to fork the project and implement your preferred approach.** - Thank you for respecting our perspective and for your continued support and contributions. We're excited to keep building with the community around the vision we've established together! From 37a6efa2d377ffd0d48c0c17a76bd77ffd3095ad Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Mon, 24 Nov 2025 05:24:22 -0500 Subject: [PATCH 06/12] Update license.mdx --- docs/license.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/license.mdx b/docs/license.mdx index 9a5c1ea..40f61f7 100644 --- a/docs/license.mdx +++ b/docs/license.mdx @@ -13,7 +13,7 @@ import { TopBanners } from "@site/src/components/TopBanners"; :::tip **Here's the TL;DR:** -To keep Open WebUI thriving for the long term, we’ve introduced a **lightweight branding protection clause** that helps us sustain the project while ensuring **every user** continues to benefit from rapid innovation **without resorting to gated features or paywalled functionality**. Branding requirements **only apply to larger deployments (50+ users)**. Deployments with 50 or fewer users may fully rebrand if they choose. +To keep Open WebUI thriving for the long term, we’ve introduced a **lightweight branding protection clause** with Open WebUI v0.6.6+ that helps us sustain the project while ensuring **every user** continues to benefit from rapid innovation **without resorting to gated features or paywalled functionality**. Branding requirements **only apply to larger deployments (50+ users)**. Deployments with 50 or fewer users may fully rebrand if they choose. As a small, independent team building mission-critical AI tooling, we rely on fair attribution to **support ongoing development, security, and quality**, all without restricting real users, contributors, or businesses who use Open WebUI responsibly. From 160cacb4a9e5565c4e7e30fc0ac08b00c7b88dac Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 14:16:39 +0100 Subject: [PATCH 07/12] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 9239f9b..38c2722 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -1614,6 +1614,14 @@ If you want to use Milvus, be careful when upgrading Open WebUI (crate backups a ::: +| Collection Variable | Default Name (Suffix) | Trigger / Routing Logic in the Code | Purpose | +| :--- | :--- | :--- | :--- | +| `HASH_BASED_COLLECTION` | `_hash_based` | Collection name is a **63-char hex string** (SHA256 hash). | Caching direct URL fetches (Websites) with the `#` feature. | +| `MEMORY_COLLECTION` | `_memories` | Collection name starts with **`user-memory-`**. | Storing user-specific long-term memories of the experimental memory system. | +| `FILE_COLLECTION` | `_files` | Collection name starts with **`file-`**. | Storing uploaded documents (PDFs, DOCX, etc.). | +| `WEB_SEARCH_COLLECTION`| `_web_search` | Collection name starts with **`web-search-`**. | Storing transient results from search engine queries. | +| `KNOWLEDGE_COLLECTION` | `_knowledge` | **Everything else** (Default fallback). | Storing explicitly created Knowledge Bases. | + :::info **Migration from Legacy Mode to Multitenancy** From 7e748f922b4da00e3d4ead2d57ef2a3bf6271280 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 14:19:40 +0100 Subject: [PATCH 08/12] Update connection-error.mdx --- docs/troubleshooting/connection-error.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting/connection-error.mdx b/docs/troubleshooting/connection-error.mdx index c1445cb..0d4e7f3 100644 --- a/docs/troubleshooting/connection-error.mdx +++ b/docs/troubleshooting/connection-error.mdx @@ -68,7 +68,7 @@ The `CORS_ALLOW_ORIGIN` setting is crucial for WebSocket functionality. If you s ### Reverse Proxy / SSL/TLS Configuration -For reverse proxy and TLS setups, check our [tutorials here](docs/tutorials/https). +For reverse proxy and TLS setups, check our [tutorials here](/docs/tutorials/https). ### WebSocket Troubleshooting From 80662a5af7ff9582f55f7f0a0426a7e1485cb026 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 14:30:15 +0100 Subject: [PATCH 09/12] Update connection-error.mdx --- docs/troubleshooting/connection-error.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting/connection-error.mdx b/docs/troubleshooting/connection-error.mdx index 0d4e7f3..bcd33e4 100644 --- a/docs/troubleshooting/connection-error.mdx +++ b/docs/troubleshooting/connection-error.mdx @@ -68,7 +68,7 @@ The `CORS_ALLOW_ORIGIN` setting is crucial for WebSocket functionality. If you s ### Reverse Proxy / SSL/TLS Configuration -For reverse proxy and TLS setups, check our [tutorials here](/docs/tutorials/https). +For reverse proxy and TLS setups, check our [tutorials here](/docs/tutorials/https/). ### WebSocket Troubleshooting From 7e59becd588a394c75f7f8c76157927a44065bd5 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 14:33:42 +0100 Subject: [PATCH 10/12] Update connection-error.mdx --- docs/troubleshooting/connection-error.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/troubleshooting/connection-error.mdx b/docs/troubleshooting/connection-error.mdx index bcd33e4..9853b67 100644 --- a/docs/troubleshooting/connection-error.mdx +++ b/docs/troubleshooting/connection-error.mdx @@ -68,7 +68,7 @@ The `CORS_ALLOW_ORIGIN` setting is crucial for WebSocket functionality. If you s ### Reverse Proxy / SSL/TLS Configuration -For reverse proxy and TLS setups, check our [tutorials here](/docs/tutorials/https/). +For reverse proxy and TLS setups, check our [tutorials here](/category/https). ### WebSocket Troubleshooting From f259caed08138f3efe0efb15f76eca213bc91540 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 16:30:22 +0100 Subject: [PATCH 11/12] =?UTF-8?q?Rename=20compatibility.mdx=E2=80=8E=20to?= =?UTF-8?q?=20compatibility.mdx?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/troubleshooting/{compatibility.mdx‎ => compatibility.mdx} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/troubleshooting/{compatibility.mdx‎ => compatibility.mdx} (100%) diff --git a/docs/troubleshooting/compatibility.mdx‎ b/docs/troubleshooting/compatibility.mdx similarity index 100% rename from docs/troubleshooting/compatibility.mdx‎ rename to docs/troubleshooting/compatibility.mdx From 88cfaa45c5f9ee1a2e67a552681ae4c4a0946fb8 Mon Sep 17 00:00:00 2001 From: Classic298 <27028174+Classic298@users.noreply.github.com> Date: Mon, 24 Nov 2025 19:24:55 +0100 Subject: [PATCH 12/12] Update env-configuration.mdx --- docs/getting-started/env-configuration.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/getting-started/env-configuration.mdx b/docs/getting-started/env-configuration.mdx index 38c2722..ea9112b 100644 --- a/docs/getting-started/env-configuration.mdx +++ b/docs/getting-started/env-configuration.mdx @@ -200,6 +200,12 @@ is also being used and set to `True`. **Never disable this if OAUTH/SSO is not b - Default: `0` - Description: Sets the thread pool size for FastAPI/AnyIO blocking calls. By default (when set to `0`) FastAPI/AnyIO use `40` threads. In case of large instances and many concurrent users, it may be needed to increase `THREAD_POOL_SIZE` to prevent blocking. +:::info + +If you are running larger instances, you WILL NEED to set this to a higher value like multiple hundreds if not thousands (e.g. `1000`) otherwise your app may get stuck the default pool size (which is 40 threads) is full and will not react anymore. + +::: + #### `MODELS_CACHE_TTL` - Type: `int`