diff --git a/.gitignore b/.gitignore index 280c6e6ea..72353ddb6 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,9 @@ .docusaurus .cache-loader +# Local banner render scratch (not for commit) +.scratch_banner + # Misc .DS_Store .env.local diff --git a/docs/enterprise/customers/astellas-pharma.mdx b/docs/enterprise/customers/astellas-pharma.mdx index 31a638891..6becf0219 100644 --- a/docs/enterprise/customers/astellas-pharma.mdx +++ b/docs/enterprise/customers/astellas-pharma.mdx @@ -22,8 +22,8 @@ How Astellas Pharma Inc. built a secure, flexible internal AI platform with **Op - **Industry**: Pharmaceutical - **Deployment**: Azure AKS (private endpoints) - **Models**: Azure OpenAI, Gemini, DeepSeek, Perplexity -- **Time-to-deploy**: ~1 month (April–May 2025) -- **Adoption**: 30–40% weekly active users sustained over five months +- **Time-to-deploy**: ~1 month (April to May 2025) +- **Adoption**: 30 to 40% weekly active users sustained over five months - **Key Results**: 420+ custom models created, 68% of users report significant efficacy gains, +43 NPS @@ -60,7 +60,7 @@ Open WebUI was selected for its **flexibility, fine-grained permission controls, - **Security Controls**: MFA via IdP, RBAC by group, data residency enforced -> “Open WebUI allowed us to create and share custom AI models securely across the entire company, while giving us the flexibility to leverage the full potential of any cutting-edge model available.” - Generative AI Team Manager, Astellas +> “Open WebUI allowed us to create and share custom AI models securely across the entire company, while giving us the flexibility to leverage the full potential of any cutting-edge model available.” Generative AI Team Manager, Astellas ## Models & Data Handling @@ -84,12 +84,12 @@ Training included: Over the following months: -- **Weekly active users stabilized at 30–40%** over five months +- **Weekly active users stabilized at 30 to 40%** over five months - Users organically created **hundreds of custom models**, sharing them across departments - **All departments** adopted the platform, including Research, Clinical Development, Medical, Sales, Marketing, Legal, Compliance, Pharmacovigilance, Administration, Communications, and Corporate Strategy -> “Our efficiency in gathering external scientific information has improved dramatically. Being able to select and switch models depending on the use case makes our research far more effective.” - Research Department User, Astellas +> “Our efficiency in gathering external scientific information has improved dramatically. Being able to select and switch models depending on the use case makes our research far more effective.” Research Department User, Astellas ## Results: Democratization, Productivity, and Satisfaction @@ -114,7 +114,7 @@ The platform grew to **3,200+ total users** organically, with an advanced user b R&D and research teams reported dramatic improvements in gathering and synthesizing scientific information, clinical trial summaries, and multilingual medical documents. -> “For coding tasks, efficiency has increased more than ten-fold, I can’t imagine working without this tool now.” - Advanced User, Astellas +> “For coding tasks, efficiency has increased more than ten-fold, I can’t imagine working without this tool now.” Advanced User, Astellas ## Top Use Cases @@ -146,7 +146,7 @@ R&D and research teams reported dramatic improvements in gathering and synthesiz :::tip -**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** — **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** +**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** Get **enhanced capabilities**, including **custom theming and branding**, **Service Level Agreement (SLA) support**, **Long-Term Support (LTS) versions**, and **more!** diff --git a/docs/enterprise/customers/public-storage.mdx b/docs/enterprise/customers/public-storage.mdx index 7f3ffec7e..81344c893 100644 --- a/docs/enterprise/customers/public-storage.mdx +++ b/docs/enterprise/customers/public-storage.mdx @@ -17,7 +17,7 @@ How Public Storage used a **champion-driven rollout** to deploy a secure, privat ### At a Glance -- **Users**: 5,000–10,000 employees +- **Users**: 5,000 to 10,000 employees - **Region**: United States (data residency enforced) - **Industry**: Real Estate - **Deployment**: GCP (containerized, private networking) @@ -60,7 +60,7 @@ Open WebUI was selected for its **extensible foundation**: an open architecture - **Security Controls**: MFA via IdP, RBAC by group, data residency enforced, PII redaction with user-facing interruption, moderation guardrails, audit exports to SIEM, DLP policies, egress restrictions -> “Our goal wasn’t just to deploy AI, but to scale it responsibly. Open WebUI allows us to crowdsource high-value use cases from the business while maintaining the governance we need.” — CTO, Public Storage +> “Our goal wasn’t just to deploy AI, but to scale it responsibly. Open WebUI allows us to crowdsource high-value use cases from the business while maintaining the governance we need.” CTO, Public Storage ## Models & Data Handling @@ -84,7 +84,7 @@ Within the first month: - Usage continued to grow as teams **shared successful workflows** with peers - **All corporate functions** were represented, including HR, Marketing, Finance, Legal, Call Center, Operations, Sales/Acquisitions, IT, and Risk Management -> “We’re seeing real operational time savings from use cases built by the business, not just IT, which has accelerated adoption and delivered practical results.” — VP, Digital Technology, Public Storage +> “We’re seeing real operational time savings from use cases built by the business, not just IT, which has accelerated adoption and delivered practical results.” VP, Digital Technology, Public Storage ## Results: Productivity, Adoption, and Governance @@ -132,7 +132,7 @@ The platform empowered every corporate function to discover and share AI-driven :::tip -**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** — **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** +**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** Get **enhanced capabilities**, including **custom theming and branding**, **Service Level Agreement (SLA) support**, **Long-Term Support (LTS) versions**, and **more!** diff --git a/docs/enterprise/customers/samsung-semiconductor.mdx b/docs/enterprise/customers/samsung-semiconductor.mdx index bbc23cd61..490364322 100644 --- a/docs/enterprise/customers/samsung-semiconductor.mdx +++ b/docs/enterprise/customers/samsung-semiconductor.mdx @@ -17,7 +17,7 @@ How Samsung Semiconductor built a secure, self-hosted AI platform with **Open We ### At a Glance -- **Users**: 1,000 - 4,999 employees +- **Users**: 1,000 to 4,999 employees - **Region**: United States (data residency enforced) - **Industry**: Semiconductor - **Deployment**: On-prem Kubernetes cluster @@ -58,7 +58,7 @@ Open WebUI was selected for its **open architecture, flexibility, and rapid proo - **Security Controls**: Data residency enforced; internal user access controls -> “Open WebUI gave us control across security, models, and UX, without vendor lock-in.” — Software Engineering, Samsung Semiconductor, Inc. +> “Open WebUI gave us control across security, models, and UX, without vendor lock-in.” Software Engineering, Samsung Semiconductor, Inc. ## Adoption & Enablement @@ -69,7 +69,7 @@ Within 30 days: - Daily active users stabilized at 5-10% of total employees - R&D teams reported **significant productivity improvements** -> “Open WebUI provides users with an environment similar to commercial tools, giving them a sense of familiarity, and at the same time, it has the advantage of improving usability with its simple and intuitive design.” — AI/ML Engineering, Samsung Semiconductor, Inc. +> “Open WebUI provides users with an environment similar to commercial tools, giving them a sense of familiarity, and at the same time, it has the advantage of improving usability with its simple and intuitive design.” AI/ML Engineering, Samsung Semiconductor, Inc. ## Results: Speed, Adoption, and Control @@ -109,7 +109,7 @@ Samsung Semiconductor plans to continue expanding its AI infrastructure with Ope :::tip -**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** — **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** +**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** **[Speak with Our Sales Team Today!](https://docs.openwebui.com/enterprise)** Get **enhanced capabilities**, including **custom theming and branding**, **Service Level Agreement (SLA) support**, **Long-Term Support (LTS) versions**, and **more!** diff --git a/docs/enterprise/deployment/container-service.md b/docs/enterprise/deployment/container-service.md index 9ca996f93..94b6e0069 100644 --- a/docs/enterprise/deployment/container-service.md +++ b/docs/enterprise/deployment/container-service.md @@ -8,7 +8,7 @@ title: "Container Service" Run the official `ghcr.io/open-webui/open-webui` image on a managed container platform such as AWS ECS/Fargate, Azure Container Apps, or Google Cloud Run. :::info Prerequisites -Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements) — PostgreSQL, Redis, a vector database, shared storage, and content extraction. +Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements): PostgreSQL, Redis, a vector database, shared storage, and content extraction. ::: ## When to Choose This Pattern @@ -49,7 +49,7 @@ Use **versioned tags** for production stability: ghcr.io/open-webui/open-webui:v0.x.x ``` -Avoid the `:main` tag in production — it tracks the latest development build and can introduce breaking changes without warning. Check the [Open WebUI releases](https://github.com/open-webui/open-webui/releases) for the latest stable version. +Avoid the `:main` tag in production. It tracks the latest development build and can introduce breaking changes without warning. Check the [Open WebUI releases](https://github.com/open-webui/open-webui/releases) for the latest stable version. ## Scaling Strategy @@ -65,7 +65,7 @@ Avoid the `:main` tag in production — it tracks the latest development build a | **Storage** | Use object storage (S3, GCS, Azure Blob) or a shared filesystem (such as EFS). Container-local storage is ephemeral and not shared across tasks. | | **Tika sidecar** | Run Tika as a sidecar container in the same task definition, or as a separate service. Sidecar pattern keeps extraction traffic local. | | **Secrets management** | Use your platform's secrets manager (AWS Secrets Manager, Azure Key Vault, GCP Secret Manager) for `DATABASE_URL`, `REDIS_URL`, and `WEBUI_SECRET_KEY`. | -| **Updates** | Perform a rolling deployment with a single task first — this task runs migrations (`ENABLE_DB_MIGRATIONS=true`). Once healthy, scale the remaining tasks with `ENABLE_DB_MIGRATIONS=false`. | +| **Updates** | Perform a rolling deployment with a single task first. This task runs migrations (`ENABLE_DB_MIGRATIONS=true`). Once healthy, scale the remaining tasks with `ENABLE_DB_MIGRATIONS=false`. | ## Anti-Patterns to Avoid diff --git a/docs/enterprise/deployment/index.md b/docs/enterprise/deployment/index.md index 365b72965..e492395b4 100644 --- a/docs/enterprise/deployment/index.md +++ b/docs/enterprise/deployment/index.md @@ -5,7 +5,7 @@ title: "Deployment Options" # Scalable Enterprise Deployment Options -Open WebUI's **stateless, container-first architecture** means the same application runs identically whether you deploy it as a Python process on a VM, a container in a managed service, or a pod in a Kubernetes cluster. The difference between deployment patterns is how you **orchestrate, scale, and operate** the application — not how the application itself behaves. +Open WebUI's **stateless, container-first architecture** means the same application runs identically whether you deploy it as a Python process on a VM, a container in a managed service, or a pod in a Kubernetes cluster. The difference between deployment patterns is how you **orchestrate, scale, and operate** the application, not how the application itself behaves. :::tip Model Inference Is Independent How you serve LLM models is separate from how you deploy Open WebUI. You can use **managed APIs** (OpenAI, Anthropic, Azure OpenAI, Google Gemini) or **self-hosted inference** (Ollama, vLLM) with any deployment pattern. See [Integration](/enterprise/integration) for details on connecting models. @@ -83,7 +83,7 @@ Deploy `open-webui serve` as a systemd-managed process on virtual machines in a ### [Container Service](./container-service) -Run the official Open WebUI container image on a managed platform such as AWS ECS/Fargate, Azure Container Apps, or Google Cloud Run. Best for teams wanting container benefits — immutable images, versioned deployments, no OS management — without Kubernetes complexity. +Run the official Open WebUI container image on a managed platform such as AWS ECS/Fargate, Azure Container Apps, or Google Cloud Run. Best for teams wanting container benefits (immutable images, versioned deployments, no OS management) without Kubernetes complexity. ### [Kubernetes with Helm](./kubernetes-helm) @@ -95,9 +95,9 @@ Deploy using the official Open WebUI Helm chart on any Kubernetes distribution ( | | **Python / Pip (VMs)** | **Container Service** | **Kubernetes (Helm)** | | :--- | :--- | :--- | :--- | -| **Operational complexity** | Moderate — OS patching, Python management | Low — platform-managed containers | Higher — requires K8s expertise | +| **Operational complexity** | Moderate (OS patching, Python management) | Low (platform-managed containers) | Higher (requires K8s expertise) | | **Auto-scaling** | Cloud ASG/VMSS with health checks | Platform-native, minimal configuration | HPA with fine-grained control | -| **Container isolation** | None — process runs directly on OS | Full container isolation | Full container + namespace isolation | +| **Container isolation** | None (process runs directly on OS) | Full container isolation | Full container + namespace isolation | | **Rolling updates** | Manual (scale down, update, scale up) | Platform-managed rolling deployments | Declarative rolling updates with rollback | | **Infrastructure-as-code** | Terraform/Pulumi for VMs + config mgmt | Task/service definitions (CloudFormation, Bicep, Terraform) | Helm charts + GitOps (Argo CD, Flux) | | **Best suited for** | Teams with VM-centric operations, regulatory constraints | Teams wanting container benefits without K8s complexity | Large-scale, mission-critical deployments | @@ -111,8 +111,8 @@ Production deployments should include monitoring and observability regardless of ### Health Checks -- **`/health`** — Basic liveness check. Returns HTTP 200 when the application is running. Use this for load balancer and auto-scaler health checks. -- **`/api/models`** — Verifies the application can connect to configured model backends. Requires an API key. +- **`/health`**: Basic liveness check. Returns HTTP 200 when the application is running. Use this for load balancer and auto-scaler health checks. +- **`/api/models`**: Verifies the application can connect to configured model backends. Requires an API key. ### OpenTelemetry @@ -124,7 +124,7 @@ OTEL_EXPORTER_OTLP_ENDPOINT=http://your-collector:4318 OTEL_SERVICE_NAME=open-webui ``` -This auto-instruments FastAPI, SQLAlchemy, Redis, and HTTP clients — giving visibility into request latency, database query performance, and cross-service traces. +This auto-instruments FastAPI, SQLAlchemy, Redis, and HTTP clients, giving visibility into request latency, database query performance, and cross-service traces. ### Structured Logging @@ -141,11 +141,11 @@ For full monitoring setup details, see [Monitoring](/reference/monitoring) and [ ## Next Steps -- **[Architecture & High Availability](/enterprise/architecture)** — Deeper dive into Open WebUI's stateless design and HA capabilities. -- **[Security](/enterprise/security)** — Compliance frameworks, SSO/LDAP integration, RBAC, and audit logging. -- **[Integration](/enterprise/integration)** — Connecting AI models, pipelines, and extending functionality. -- **[Scaling Open WebUI](/getting-started/advanced-topics/scaling)** — The complete step-by-step technical scaling guide. -- **[Multi-Replica Troubleshooting](/troubleshooting/multi-replica)** — Solutions for common issues in scaled deployments. +- **[Architecture & High Availability](/enterprise/architecture)**: Deeper dive into Open WebUI's stateless design and HA capabilities. +- **[Security](/enterprise/security)**: Compliance frameworks, SSO/LDAP integration, RBAC, and audit logging. +- **[Integration](/enterprise/integration)**: Connecting AI models, pipelines, and extending functionality. +- **[Scaling Open WebUI](/getting-started/advanced-topics/scaling)**: The complete step-by-step technical scaling guide. +- **[Multi-Replica Troubleshooting](/troubleshooting/multi-replica)**: Solutions for common issues in scaled deployments. --- diff --git a/docs/enterprise/deployment/kubernetes-helm.md b/docs/enterprise/deployment/kubernetes-helm.md index f5d15dbe2..d4ea0c0ce 100644 --- a/docs/enterprise/deployment/kubernetes-helm.md +++ b/docs/enterprise/deployment/kubernetes-helm.md @@ -8,7 +8,7 @@ title: "Kubernetes with Helm" Deploy using the official Open WebUI Helm chart on any Kubernetes distribution (EKS, AKS, GKE, OpenShift, Rancher, self-managed). :::info Prerequisites -Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements) — PostgreSQL, Redis, a vector database, shared storage, and content extraction. +Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements): PostgreSQL, Redis, a vector database, shared storage, and content extraction. ::: ## When to Choose This Pattern @@ -62,7 +62,7 @@ helm repo update helm install openwebui open-webui/open-webui -f values.yaml ``` -Your `values.yaml` should override the defaults to point at your shared infrastructure. The chart has dedicated values for many common settings — use these instead of raw environment variables where available: +Your `values.yaml` should override the defaults to point at your shared infrastructure. The chart has dedicated values for many common settings: use these instead of raw environment variables where available: ```yaml # Example values.yaml overrides (refer to chart documentation for full schema) diff --git a/docs/enterprise/deployment/python-pip.md b/docs/enterprise/deployment/python-pip.md index cbbb34fe9..752de41e2 100644 --- a/docs/enterprise/deployment/python-pip.md +++ b/docs/enterprise/deployment/python-pip.md @@ -8,7 +8,7 @@ title: "Python / Pip on VMs" Deploy `open-webui serve` as a systemd-managed process on virtual machines in a cloud auto-scaling group (AWS ASG, Azure VMSS, GCP MIG). :::info Prerequisites -Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements) — PostgreSQL, Redis, a vector database, shared storage, and content extraction. +Before proceeding, ensure you have configured the [shared infrastructure requirements](/enterprise/deployment#shared-infrastructure-requirements): PostgreSQL, Redis, a vector database, shared storage, and content extraction. ::: ## When to Choose This Pattern diff --git a/docs/enterprise/index.mdx b/docs/enterprise/index.mdx index 14de90082..09a9cc7bc 100644 --- a/docs/enterprise/index.mdx +++ b/docs/enterprise/index.mdx @@ -83,7 +83,7 @@ Understand how Open WebUI supports large-scale deployments. Explore multi-node c Learn how Open WebUI integrates with your existing identity infrastructure, including LDAP, Active Directory, and SSO providers. Ideal for organizations requiring on-premise or air-gapped deployments. #### [🚀 Deployment Options](./deployment) -Choose the right deployment pattern for your organization — from Python on auto-scaling VMs to managed container services to Kubernetes with Helm. +Choose the right deployment pattern for your organization, from Python on auto-scaling VMs to managed container services to Kubernetes with Helm. #### [🔗 Integration](./integration) Connect proprietary, third-party, or local AI models. Extend functionality with plugins, pipelines, and custom workflows that fit your existing infrastructure. diff --git a/docs/faq.mdx b/docs/faq.mdx index 58ea25841..82b7e1c5d 100644 --- a/docs/faq.mdx +++ b/docs/faq.mdx @@ -9,14 +9,14 @@ title: "❓ FAQ" **A:** Community support for Open WebUI is provided by **volunteers** who generously contribute their time and expertise. Because of this, responses are best-effort and may not always be immediate or personalized. For organizations that need dedicated, guaranteed support, check out our **[Enterprise offerings](https://docs.openwebui.com/enterprise)**. **To get the best help:** -1. **Search first.** Check these docs, [Discord](https://discord.gg/5rJgQTnV4s), [Reddit](https://www.reddit.com/r/OpenWebUI/), [GitHub Discussions](https://github.com/open-webui/open-webui/discussions), and [Issues](https://github.com/open-webui/open-webui/issues) — your question may already be answered. +1. **Search first.** Check these docs, [Discord](https://discord.gg/5rJgQTnV4s), [Reddit](https://www.reddit.com/r/OpenWebUI/), [GitHub Discussions](https://github.com/open-webui/open-webui/discussions), and [Issues](https://github.com/open-webui/open-webui/issues). Your question may already be answered. 2. **Try the Discord bot.** In our [Discord server](https://discord.gg/5rJgQTnV4s)'s **#questions** channel, we have an experimental bot that has access to all issues, all discussions, and the entire documentation. Simply ping the bot with your question in the same message, wait a few seconds, and it will answer you. As our documentation improves, so does the bot. 3. **Provide details.** When asking for help, include: your Open WebUI version, deployment method (Docker/pip), model provider and model name, relevant settings (screenshots of the Admin Panel section are ideal), and steps to reproduce the issue. -4. **Be kind.** Contributors volunteer their limited time — respectful, well-prepared questions go a long way. Please review our **[Code of Conduct](https://github.com/open-webui/open-webui/blob/main/CODE_OF_CONDUCT.md)** before participating. +4. **Be kind.** Contributors volunteer their limited time, so respectful, well-prepared questions go a long way. Please review our **[Code of Conduct](https://github.com/open-webui/open-webui/blob/main/CODE_OF_CONDUCT.md)** before participating. **Where to ask:** -- 🤖 **Quick Answers**: [Discord #questions channel](https://discord.gg/5rJgQTnV4s) — try the bot first, it can answer most Open WebUI questions -- 🐛 **Bugs**: [GitHub Issues](https://github.com/open-webui/open-webui/issues) — please use the issue template and include all requested information (Open WebUI version, browser, deployment method, expected vs. actual behavior, and logs). Clear steps to reproduce the issue along with relevant settings are essential — reproducibility is key to getting bugs resolved quickly. Reports missing key details may be closed or converted to discussions. +- 🤖 **Quick Answers**: [Discord #questions channel](https://discord.gg/5rJgQTnV4s). Try the bot first, it can answer most Open WebUI questions +- 🐛 **Bugs**: [GitHub Issues](https://github.com/open-webui/open-webui/issues). Please use the issue template and include all requested information (Open WebUI version, browser, deployment method, expected vs. actual behavior, and logs). Clear steps to reproduce the issue along with relevant settings are essential, and reproducibility is key to getting bugs resolved quickly. Reports missing key details may be closed or converted to discussions. - 💬 **Questions & Help**: [Discord](https://discord.gg/5rJgQTnV4s) (most active community), [Reddit](https://www.reddit.com/r/OpenWebUI/), or [GitHub Discussions](https://github.com/open-webui/open-webui/discussions) - 💡 **Feature Requests**: [GitHub Discussions](https://github.com/open-webui/open-webui/discussions/new/choose) @@ -44,11 +44,11 @@ For more details on enterprise solutions and branding customizations, [click her ### Q: I get "The prompt is too long" / "context length exceeded" after a while in a chat. How do I fix it? -**A:** This error comes from the **model provider**, not from Open WebUI — the provider counts the tokens of everything you sent (system prompt + the *entire* chat history + attached files + tool calls + your new message) and rejects the request once it exceeds the model's context window. The "prompt" the model sees is the whole conversation, not just your latest message. +**A:** This error comes from the **model provider**, not from Open WebUI. The provider counts the tokens of everything you sent (system prompt + the *entire* chat history + attached files + tool calls + your new message) and rejects the request once it exceeds the model's context window. The "prompt" the model sees is the whole conversation, not just your latest message. Open WebUI intentionally does **not** ship a built-in context trimmer. Every model has a different tokenizer and a different context window, and every deployment wants a different truncation policy (by tokens, by turns, by message count, file-attachments-first, summarize-and-replace, per-model budgets, and so on). There is no single policy that is correct for every user, so we expose the hook instead of choosing one for you. -Context management is done with [filter Functions](/features/extensibility/plugin/functions/filter): `inlet()` receives the full `body["messages"]` on every request and can modify it freely (drop old turns, enforce a turn limit, summarize, trim attachments, etc.). Many community-maintained context filters are already available one-click on [openwebui.com](https://openwebui.com/) — browse, install, and tune the valves. If none fits, copy the closest one into **Admin Panel → Functions** and edit it. +Context management is done with [filter Functions](/features/extensibility/plugin/functions/filter): `inlet()` receives the full `body["messages"]` on every request and can modify it freely (drop old turns, enforce a turn limit, summarize, trim attachments, etc.). Many community-maintained context filters are already available one-click on [openwebui.com](https://openwebui.com/): browse, install, and tune the valves. If none fits, copy the closest one into **Admin Panel → Functions** and edit it. For the full write-up with examples, see [Context Window / Prompt Too Long](/troubleshooting/context-window). @@ -56,9 +56,9 @@ For the full write-up with examples, see [Context Window / Prompt Too Long](/tro **A:** **Yes.** Open WebUI is a self-hosted, **internet-independent AI platform** designed to work in **air-gapped networks**, **remote deployments**, and any environment where cloud-based systems are impractical or impossible. Whether you need to **run an LLM without internet**, deploy a **private AI with no cloud dependency**, or operate a **local AI chatbot offline**, Open WebUI supports all of these out of the box. It runs entirely on local hardware and does not make external calls by default. -This **Earth-independent architecture** is well suited as an **AI interface for space exploration** — spacecraft, the ISS, lunar bases, Mars habitats, and deep-space missions — where communication delays or total network isolation make cloud AI unworkable. Whether you need **self-hosted AI for remote locations** or need to **run AI in a disconnected environment**, Open WebUI's **offline-first design** keeps models, tools, and data local and predictable even under extreme latency or complete disconnection. +This **Earth-independent architecture** is well suited as an **AI interface for space exploration** (spacecraft, the ISS, lunar bases, Mars habitats, and deep-space missions) where communication delays or total network isolation make cloud AI unworkable. Whether you need **self-hosted AI for remote locations** or need to **run AI in a disconnected environment**, Open WebUI's **offline-first design** keeps models, tools, and data local and predictable even under extreme latency or complete disconnection. -The same principles apply to harsh terrestrial settings: submarines, polar research stations, underground facilities, **air-gapped networks**, disaster zones, field operations, and mobile command environments. Open WebUI serves as an **offline AI interface** for defense, research, and critical infrastructure where internet access is unavailable, unreliable, or prohibited. If your system can boot and power itself, Open WebUI is designed to run — no network required. +The same principles apply to harsh terrestrial settings: submarines, polar research stations, underground facilities, **air-gapped networks**, disaster zones, field operations, and mobile command environments. Open WebUI serves as an **offline AI interface** for defense, research, and critical infrastructure where internet access is unavailable, unreliable, or prohibited. If your system can boot and power itself, Open WebUI is designed to run, no network required. ### Q: Why am I asked to sign up? Where are my data being sent to? @@ -204,7 +204,7 @@ For complete workflow examples, see the **[API Endpoints documentation](/referen ### Q: I asked the model what it is and it gave the wrong answer. Is Open WebUI routing to the wrong model? -**A:** No—**LLMs do not reliably know their own identity.** When you ask a model "What model are you?" or "Are you GPT-4?", the response is not a system diagnostic. It's simply the model generating text based on patterns in its training data. +**A:** No. **LLMs do not reliably know their own identity.** When you ask a model "What model are you?" or "Are you GPT-4?", the response is not a system diagnostic. It's simply the model generating text based on patterns in its training data. Models frequently: - Claim to be a different model (e.g., a Llama model claiming to be ChatGPT) @@ -223,9 +223,9 @@ Asking the model itself is **not** a valid way to diagnose routing issues. If yo **A:** Because the provider **injects a system prompt** that explicitly tells the model what it is. When you use ChatGPT, OpenAI's interface includes a hidden system message like "You are ChatGPT, a large language model trained by OpenAI..." before your conversation begins. -The model isn't "aware" of itself—it's simply been instructed to claim a specific identity. You can do the same thing in Open WebUI by adding a system prompt to your model configuration (e.g., "You are Llama 3.3 70B..."). The model will then confidently repeat whatever identity you've told it to claim. +The model isn't "aware" of itself; it's simply been instructed to claim a specific identity. You can do the same thing in Open WebUI by adding a system prompt to your model configuration (e.g., "You are Llama 3.3 70B..."). The model will then confidently repeat whatever identity you've told it to claim. -This is also why the same model accessed through different interfaces might give different answers about its identity—it depends entirely on what system prompt (if any) was provided. +This is also why the same model accessed through different interfaces might give different answers about its identity; it depends entirely on what system prompt (if any) was provided. ### Q: Why am I seeing multiple API requests when I only send one message? Why is my token usage higher than expected? @@ -256,14 +256,14 @@ For more optimization tips, see the **[Performance Tips Guide](troubleshooting/p ### Q: Why doesn't Open WebUI natively support [Provider X]'s proprietary API? -**A:** Open WebUI is highly modular with a plugin system including tools, functions, and most notably **[pipes](/features/extensibility/plugin/functions/pipe)**. These modular pipes allow you to add support for virtually any provider you want—you can build your own or choose from the many [community-built](https://openwebui.com/) and usually well-maintained ones already available. +**A:** Open WebUI is highly modular with a plugin system including tools, functions, and most notably **[pipes](/features/extensibility/plugin/functions/pipe)**. These modular pipes allow you to add support for virtually any provider you want: you can build your own or choose from the many [community-built](https://openwebui.com/) and usually well-maintained ones already available. That said, Open WebUI's core is built around **universal protocols**, not specific providers. Our stance is to support standard, widely-adopted APIs like the **OpenAI Chat Completions protocol**. This protocol-centric design ensures that Open WebUI remains backend-agnostic and compatible with dozens of providers simultaneously. We avoid implementing proprietary, provider-specific APIs in the core to prevent unsustainable architectural bloat and to maintain a truly open ecosystem. :::note Experimental: Open Responses -As new standards emerge that gain broad adoption, we may add experimental support. Connections can now optionally be configured to use **[Open Responses](https://www.openresponses.org/)**—an open specification for multi-provider interoperability with consistent streaming events and tool use patterns. +As new standards emerge that gain broad adoption, we may add experimental support. Connections can now optionally be configured to use **[Open Responses](https://www.openresponses.org/)**, an open specification for multi-provider interoperability with consistent streaming events and tool use patterns. ::: We understand this request comes up frequently, especially for major providers. Here's why we've made this deliberate architectural decision: @@ -275,7 +275,7 @@ Supporting one proprietary API sets a precedent. Once that precedent exists, eve #### 2. Maintenance is the Real Burden Adding integration code is the easy part. **Maintaining it forever** is where the real cost lies: -- Each provider updates their API independently—when a provider changes something, we must update and test immediately +- Each provider updates their API independently. When a provider changes something, we must update and test immediately - Changes in one integration can break compatibility with others - Every integration requires ongoing testing across multiple scenarios - Bug reports flood in for each provider whenever they make changes @@ -317,7 +317,7 @@ The assumption that bundling the frontend with the backend is unscalable comes f ### Q: Is Open WebUI scalable for large organizations or enterprise deployments? -**A:** Yes, **Open WebUI is architected for scalability and production readiness.** With the right infrastructure, it supports deployments at significant scale—**including organizations with tens of thousands of users**—across universities, multinational enterprises, and government agencies worldwide. See the [Scaling Guide](/getting-started/advanced-topics/scaling) for the infrastructure requirements at each stage. +**A:** Yes, **Open WebUI is architected for scalability and production readiness.** With the right infrastructure, it supports deployments at significant scale (**including organizations with tens of thousands of users**) across universities, multinational enterprises, and government agencies worldwide. See the [Scaling Guide](/getting-started/advanced-topics/scaling) for the infrastructure requirements at each stage. Open WebUI’s stateless, container-first architecture means you’re not limited to a single server. Through horizontal scaling, flexible storage backends, externalized authentication and database support, and full container orchestration compatibility (for example, Kubernetes or Docker Swarm), you can build robust, high-availability clusters to meet even the most demanding enterprise requirements. @@ -337,17 +337,17 @@ If you’re planning a high-availability, enterprise-grade deployment, we recomm 👉 [The SRE's Guide to High Availability Open WebUI Deployment Architecture](http://taylorwilsdon.medium.com/the-sres-guide-to-high-availability-open-webui-deployment-architecture-2ee42654eced) *(This provides a strong technical overview and best practices for large-scale Open WebUI architecture.)* -Open WebUI is designed from day one to not just handle, but thrive at scale—serving large organizations, universities, and enterprises worldwide. +Open WebUI is designed from day one to not just handle, but thrive at scale, serving large organizations, universities, and enterprises worldwide. ### Q: How often is Open WebUI updated? (Release Schedule) -**A:** We aim to ship **major releases weekly**, with **bug fixes and minor updates delivered as needed**. However, this is not a rigid schedule—some weeks may see multiple releases, while others might have none at all. +**A:** We aim to ship **major releases weekly**, with **bug fixes and minor updates delivered as needed**. However, this is not a rigid schedule. Some weeks may see multiple releases, while others might have none at all. To stay informed, you can follow release notes and announcements on our [GitHub Releases page](https://github.com/open-webui/open-webui/releases). ### Q: Where do I report non-compliant Open WebUI deployments that violate the license? -If you encounter an Open WebUI deployment that appears to violate the Open WebUI license—such as removed branding where it is not permitted, misleading white-labeling, commercial misuse, or any form of unauthorized redistribution—you can confidentially report it to our compliance team. +If you encounter an Open WebUI deployment that appears to violate the Open WebUI license (such as removed branding where it is not permitted, misleading white-labeling, commercial misuse, or any form of unauthorized redistribution) you can confidentially report it to our compliance team. 📩 **Email:** **[reports@openwebui.com](mailto:reports@openwebui.com)** Please include any relevant details (screenshots, URLs, description of usage, etc.) so we can investigate appropriately. diff --git a/docs/features/administration/_category_.json b/docs/features/administration/_category_.json index 34268e388..fe419a9e4 100644 --- a/docs/features/administration/_category_.json +++ b/docs/features/administration/_category_.json @@ -1,6 +1,6 @@ { "label": "🔧 Administration", - "position": 10, + "position": 46, "collapsible": true, "collapsed": true } diff --git a/docs/features/administration/banners.md b/docs/features/administration/banners.md index caad5e381..206e0af3c 100644 --- a/docs/features/administration/banners.md +++ b/docs/features/administration/banners.md @@ -113,7 +113,7 @@ If users dismissed a banner and you want them to see an updated message, change ## Supported content formatting (HTML only) -Banner `title` and `content` support a subset of **HTML only** — Markdown syntax is not rendered. Unsupported tags may render as plain text or break the layout. +Banner `title` and `content` support a subset of **HTML only**: Markdown syntax is not rendered. Unsupported tags may render as plain text or break the layout. ### Text formatting @@ -239,7 +239,7 @@ renders more predictably than heavily formatted HTML with many line breaks. The following are not supported in banners and may render as plain text or break the layout: -- Headings (`

`–`

`) +- Headings (`

` to `

`) - Lists (`