diff --git a/docs/getting-started/env-configuration.md b/docs/getting-started/env-configuration.md index 687535a9..e673f34c 100644 --- a/docs/getting-started/env-configuration.md +++ b/docs/getting-started/env-configuration.md @@ -1730,6 +1730,7 @@ Provide a clear and direct response to the user's query, including inline citati - Options: - `character` - `token` + - `markdown_header` - Default: `character` - Description: Sets the text splitter for RAG models. - Persistence: This environment variable is a `PersistentConfig` variable. diff --git a/docs/getting-started/quick-start/tab-docker/DockerCompose.md b/docs/getting-started/quick-start/tab-docker/DockerCompose.md index a3765c21..63dc6e06 100644 --- a/docs/getting-started/quick-start/tab-docker/DockerCompose.md +++ b/docs/getting-started/quick-start/tab-docker/DockerCompose.md @@ -24,6 +24,24 @@ volumes: open-webui: ``` +### Using Slim Images + +For environments with limited storage or bandwidth, you can use the slim image variant that excludes pre-bundled models: + +```yaml +services: + openwebui: + image: ghcr.io/open-webui/open-webui:main-slim + ports: + - "3000:8080" + volumes: + - open-webui:/app/backend/data +volumes: + open-webui: +``` + +**Note:** Slim images download required models (whisper, embedding models) on first use, which may result in longer initial startup times but significantly smaller image sizes. + ## Starting the Services To start your services, run the following command: diff --git a/docs/getting-started/quick-start/tab-docker/ManualDocker.md b/docs/getting-started/quick-start/tab-docker/ManualDocker.md index 77a52845..10a2e0bd 100644 --- a/docs/getting-started/quick-start/tab-docker/ManualDocker.md +++ b/docs/getting-started/quick-start/tab-docker/ManualDocker.md @@ -10,6 +10,14 @@ Start by pulling the latest Open WebUI Docker image from the GitHub Container Re docker pull ghcr.io/open-webui/open-webui:main ``` +### Slim Image Variant + +For environments with limited storage or bandwidth, Open WebUI offers slim image variants that exclude pre-bundled models. These images are significantly smaller but download required models (whisper, embedding models) on first use. + +```bash +docker pull ghcr.io/open-webui/open-webui:main-slim +``` + ## Step 2: Run the Container Run the container with default settings. This command includes a volume mapping to ensure persistent data storage. @@ -18,6 +26,12 @@ Run the container with default settings. This command includes a volume mapping docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main ``` +To use the slim variant instead: + +```bash +docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main-slim +``` + ### Important Flags - **Volume Mapping (`-v open-webui:/app/backend/data`)**: Ensures persistent storage of your data. This prevents data loss between container restarts. diff --git a/docs/intro.mdx b/docs/intro.mdx index 58e905bc..39720b91 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -33,7 +33,7 @@ Passionate about open-source AI? [Join our team →](https://careers.openwebui.c ![Open WebUI Demo](/images/demo.gif) :::tip -**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** – **[Speak with Our Sales Team Today!](mailto:sales@openwebui.com)** +**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** — **[Speak with Our Sales Team Today!](mailto:sales@openwebui.com)** Get **enhanced capabilities**, including **custom theming and branding**, **Service Level Agreement (SLA) support**, **Long-Term Support (LTS) versions**, and **more!** ::: @@ -60,6 +60,14 @@ docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open- docker run -d -p 3000:8080 --gpus all --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:cuda ``` +### Slim Image Variants + +For environments with limited storage or bandwidth, Open WebUI offers slim image variants that exclude pre-bundled models. These images are significantly smaller but download required models on first use: + +```bash +docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main-slim +``` + ### Open WebUI Bundled with Ollama This installation method uses a single container image that bundles Open WebUI with Ollama, allowing for a streamlined setup via a single command. Choose the appropriate command based on your hardware setup: @@ -94,6 +102,12 @@ If you want to try out the latest bleeding-edge features and are okay with occas docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:dev ``` +For the slim variant of the dev branch: + +```bash +docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:dev-slim +``` + ### Updating Open WebUI To update Open WebUI container easily, follow these steps: diff --git a/docs/pipelines/tutorials.md b/docs/pipelines/tutorials.md index 7144eb71..9b124de9 100644 --- a/docs/pipelines/tutorials.md +++ b/docs/pipelines/tutorials.md @@ -26,4 +26,8 @@ with us, as we'd love to feature it here! [Deploying custom Document RAG pipeline with Open-WebUI](https://github.com/Sebulba46/document-RAG-pipeline) (GitHub guide by Sebulba46) -- Step by step guide to deploy Open-WebUI and pipelines containers and creating your own document RAG with local LLM API. +- Step by step guide to deploy Open-WebUI and pipelines containers and creating your own document RAG with local LLM API. + +[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) + +- Learn how to deploy Open WebUI 100% secure through https. diff --git a/docs/tutorials/deployment/index.mdx b/docs/tutorials/deployment/index.mdx index a5eb7df8..615856b4 100644 --- a/docs/tutorials/deployment/index.mdx +++ b/docs/tutorials/deployment/index.mdx @@ -145,3 +145,13 @@ We're looking for talented individuals to create videos showcasing Open WebUI's allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen > + + diff --git a/docs/tutorials/docker-install.md b/docs/tutorials/docker-install.md index ac6f678d..772f9d17 100644 --- a/docs/tutorials/docker-install.md +++ b/docs/tutorials/docker-install.md @@ -3,6 +3,12 @@ sidebar_position: 4 title: 🐳 Installing Docker --- +:::info **Looking to install Open WebUI?** + +This page covers Docker installation only. For **Open WebUI installation instructions via Docker**, please visit our [Quick Start Guide](https://docs.openwebui.com/getting-started/quick-start/) which provides comprehensive setup instructions. + +::: + :::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. ::: @@ -21,7 +27,7 @@ This tutorial is a community contribution and is not supported by the Open WebUI 1. **Open your terminal.** -2. **Set up Docker’s apt repository:** +2. **Set up Docker's apt repository:** ```bash sudo apt-get update diff --git a/docs/tutorials/images.md b/docs/tutorials/images.md index f03253f5..bd1fd324 100644 --- a/docs/tutorials/images.md +++ b/docs/tutorials/images.md @@ -157,7 +157,7 @@ Open WebUI also supports image generation through the **OpenAI APIs**. This opti ### Azure OpenAI -Image generation with a Azure OpenAI Dall-E or GPT-Image is supported with OpenWeb UI. Configure the Image Generation as follows: +Image generation with Azure OpenAI Dall-E or GPT-Image is supported with Open WebUI. Configure the Image Generation as follows: 1. In Open WebUI, navigate to the **Admin Panel** > **Settings** > **Images** menu. 2. Set the `Image Generation Engine` field to `Open AI` (Azure OpenAI uses the same syntax as OpenAI). @@ -171,6 +171,8 @@ You can also copy Target URI from your deployment detailed page, but remember to For example, if your Target URI is `https://test.openai.azure.com/openai/deployments/gpt-image-1/images/generations?api-version=2025-04-01-preview`, the API endpoint URL in Open WebUI should be `https://test.openai.azure.com/openai/deployments/gpt-image-1/`. ::: +======= + ## Image Router Open WebUI also supports image generation through the **Image Router APIs**. Image Router is an [open source](https://github.com/DaWe35/image-router) image generation proxy that unifies most popular models into a single API.