diff --git a/docs/reference/https/_category_.json b/docs/reference/https/_category_.json new file mode 100644 index 00000000..685ca15f --- /dev/null +++ b/docs/reference/https/_category_.json @@ -0,0 +1,7 @@ +{ + "position": 6, + "link": { + "type": "doc", + "id": "reference/https/index" + } +} \ No newline at end of file diff --git a/docs/tutorials/https/caddy.md b/docs/reference/https/caddy.md similarity index 94% rename from docs/tutorials/https/caddy.md rename to docs/reference/https/caddy.md index 8d2a39d3..b747e978 100644 --- a/docs/tutorials/https/caddy.md +++ b/docs/reference/https/caddy.md @@ -3,11 +3,6 @@ sidebar_position: 202 title: "HTTPS using Caddy" --- -:::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. - -::: ## HTTPS Using Caddy diff --git a/docs/tutorials/https/haproxy.md b/docs/reference/https/haproxy.md similarity index 96% rename from docs/tutorials/https/haproxy.md rename to docs/reference/https/haproxy.md index 7446965a..324d2113 100644 --- a/docs/tutorials/https/haproxy.md +++ b/docs/reference/https/haproxy.md @@ -3,11 +3,6 @@ sidebar_position: 201 title: "HTTPS using HAProxy" --- -:::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. - -::: # HAProxy Configuration for Open WebUI diff --git a/docs/reference/https-encryption.md b/docs/reference/https/index.md similarity index 62% rename from docs/reference/https-encryption.md rename to docs/reference/https/index.md index 432ac860..687e71a6 100644 --- a/docs/reference/https-encryption.md +++ b/docs/reference/https/index.md @@ -1,6 +1,6 @@ --- sidebar_position: 6 -title: "Enabling HTTPS Encryption" +title: "HTTPS & Reverse Proxies" --- # Secure Your Open WebUI with HTTPS ๐Ÿ”’ @@ -28,9 +28,9 @@ The best method depends on your infrastructure. ### ๐Ÿ  For Local/Docker Users If you are running Open WebUI with Docker, the standard approach is to use a **Reverse Proxy**. This sits in front of Open WebUI and handles the SSL encryption. -* **[Nginx](/tutorials/https/nginx)**: The industry standard. Highly configurable, great performance. -* **[Caddy](/tutorials/https/caddy)**: **Easiest option**. Automatically obtains and renews Let's Encrypt certificates with minimal config. -* **[HAProxy](/tutorials/https/haproxy)**: Robust choice for advanced load balancing needs. +* **[Nginx](./nginx)**: The industry standard. Highly configurable, great performance. +* **[Caddy](./caddy)**: **Easiest option**. Automatically obtains and renews Let's Encrypt certificates with minimal config. +* **[HAProxy](./haproxy)**: Robust choice for advanced load balancing needs. ### โ˜๏ธ For Cloud Deployments * **Cloud Load Balancers**: (AWS ALB, Google Cloud Load Balancing) often handle SSL termination natively. @@ -38,26 +38,3 @@ If you are running Open WebUI with Docker, the standard approach is to use a **R ### ๐Ÿงช For Development * **Ngrok**: Good for quickly testing Voice features locally. *Not for production.* - -## ๐Ÿ“š Implementation Guides - -Ready to set it up? Check out our dedicated tutorial category for step-by-step configurations: - -
- - -

Nginx Setup

-

Manual control and high performance.

- - - -

Caddy Setup

-

Zero-config automatic HTTPS.

- - - -

๐Ÿ“‚ View All HTTPS Tutorials

-

Browse the full category of guides.

- - -
diff --git a/docs/tutorials/https/nginx.md b/docs/reference/https/nginx.md similarity index 98% rename from docs/tutorials/https/nginx.md rename to docs/reference/https/nginx.md index 916c4499..3ad977f1 100644 --- a/docs/tutorials/https/nginx.md +++ b/docs/reference/https/nginx.md @@ -3,11 +3,6 @@ sidebar_position: 200 title: "HTTPS using Nginx" --- -:::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. - -::: # HTTPS using Nginx diff --git a/docs/tutorials/tab-nginx/LetsEncrypt.md b/docs/reference/tab-nginx/LetsEncrypt.md similarity index 100% rename from docs/tutorials/tab-nginx/LetsEncrypt.md rename to docs/reference/tab-nginx/LetsEncrypt.md diff --git a/docs/tutorials/tab-nginx/NginxProxyManager.md b/docs/reference/tab-nginx/NginxProxyManager.md similarity index 100% rename from docs/tutorials/tab-nginx/NginxProxyManager.md rename to docs/reference/tab-nginx/NginxProxyManager.md diff --git a/docs/tutorials/tab-nginx/SelfSigned.md b/docs/reference/tab-nginx/SelfSigned.md similarity index 100% rename from docs/tutorials/tab-nginx/SelfSigned.md rename to docs/reference/tab-nginx/SelfSigned.md diff --git a/docs/tutorials/tab-nginx/Windows.md b/docs/reference/tab-nginx/Windows.md similarity index 100% rename from docs/tutorials/tab-nginx/Windows.md rename to docs/reference/tab-nginx/Windows.md diff --git a/docs/tutorials/tab-nginx/_category_.json b/docs/reference/tab-nginx/_category_.json similarity index 100% rename from docs/tutorials/tab-nginx/_category_.json rename to docs/reference/tab-nginx/_category_.json diff --git a/docs/troubleshooting/connection-error.mdx b/docs/troubleshooting/connection-error.mdx index 6d1af6ee..e6a369ed 100644 --- a/docs/troubleshooting/connection-error.mdx +++ b/docs/troubleshooting/connection-error.mdx @@ -69,7 +69,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](/category/https). +For reverse proxy and TLS setups, check our [tutorials here](/reference/https). ### WebSocket Troubleshooting diff --git a/docs/troubleshooting/performance.md b/docs/troubleshooting/performance.md index 9fe16ffe..089f4003 100644 --- a/docs/troubleshooting/performance.md +++ b/docs/troubleshooting/performance.md @@ -151,7 +151,7 @@ If you are deploying for **enterprise scale** (hundreds of users), simple Docker * **Kubernetes / Helm**: For deploying on K8s with multiple replicas, see the **[Multi-Replica & High Availability Guide](/troubleshooting/multi-replica)**. * **Redis (Mandatory)**: When running multiple workers (`UVICORN_WORKERS > 1`) or multiple replicas, **Redis is required** to handle WebSocket connections and session syncing. See **[Redis Integration](/tutorials/integrations/redis)**. * **Load Balancing**: Ensure your Ingress controller supports **Session Affinity** (Sticky Sessions) for best performance. -* **Reverse Proxy Caching**: Configure your reverse proxy (e.g., Nginx, Caddy, Cloudflare) to **cache static assets** (JS, CSS, Images). This significantly reduces load on the application server. See **[Nginx Config](/tutorials/https/nginx)** or **[Caddy Config](/tutorials/https/caddy)**. +* **Reverse Proxy Caching**: Configure your reverse proxy (e.g., Nginx, Caddy, Cloudflare) to **cache static assets** (JS, CSS, Images). This significantly reduces load on the application server. See **[Nginx Config](/reference/https/nginx)** or **[Caddy Config](/reference/https/caddy)**. * **Disable Proxy Buffering (Critical for Streaming)**: If using Nginx, you **must** disable `proxy_buffering` for Open WebUI. Proxy buffering re-chunks SSE streams, causing garbled markdown and slow streaming. Add `proxy_buffering off;` and `proxy_cache off;` to your location block. See **[Streaming Troubleshooting](/troubleshooting/connection-error#-garbled-markdown--streaming-response-corruption)**. --- diff --git a/docs/tutorials/https/_category_.json b/docs/tutorials/https/_category_.json deleted file mode 100644 index c143f474..00000000 --- a/docs/tutorials/https/_category_.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "label": "HTTPS", - "position": 10, - "link": { - "type": "generated-index" - } -} diff --git a/package-lock.json b/package-lock.json index 4231597d..c642f6a1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -14,7 +14,7 @@ "@docusaurus/theme-mermaid": "^3.5.2", "@mdx-js/react": "^3.0.1", "clsx": "^2.1.1", - "docusaurus-lunr-search": "^3.5.0", + "docusaurus-lunr-search": "^3.6.0", "docusaurus-plugin-sass": "^0.2.5", "marked": "^17.0.1", "prism-react-renderer": "^2.4.0", diff --git a/package.json b/package.json index eba9b37a..881b9186 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "@docusaurus/theme-mermaid": "^3.5.2", "@mdx-js/react": "^3.0.1", "clsx": "^2.1.1", - "docusaurus-lunr-search": "^3.5.0", + "docusaurus-lunr-search": "^3.6.0", "docusaurus-plugin-sass": "^0.2.5", "marked": "^17.0.1", "prism-react-renderer": "^2.4.0",