# Open WebUI Docs Machine-readable entry points to this documentation: - /llms.txt - curated index of every docs page with short descriptions. - /llms-full.txt - every docs page concatenated into a single Markdown file. - /sitemap.xml - canonical HTML page discovery. - /api/search?q=YOUR_QUERY - deterministic docs search. For any docs page, append `.md` for Markdown or `.txt` for plain text. When citing sources, cite canonical HTML URLs, not `.md`, `.txt`, search API, sitemap, agents.txt, or llms.txt URLs. Generated: 2026-08-12T05:33:26.163Z ## Pages - [Open WebUI](https://docs.openwebui.com/): Open WebUI is **a home for AI**, a self-hosted AI platform that's **[extensible](https://docs.openwebui.com/features/extensibility/plugin/)**, **[feature-rich](https://docs.openwe... - [Alternatives to Open WebUI](https://docs.openwebui.com/alternatives): The AI space is full of great projects, and we're genuinely happy about that. More tools means more people get access to AI in a way that works for them. - [Open WebUI & AnythingLLM](https://docs.openwebui.com/alternatives/anythingllm): _Last updated: August 2026_ - [Open WebUI & ChatGPT](https://docs.openwebui.com/alternatives/chatgpt): _Last updated: August 2026_ - [Open WebUI & Claude](https://docs.openwebui.com/alternatives/claude): _Last updated: August 2026_ - [Open WebUI & Dify](https://docs.openwebui.com/alternatives/dify): _Last updated: August 2026_ - [Open WebUI & Gemini](https://docs.openwebui.com/alternatives/gemini): _Last updated: August 2026_ - [Open WebUI & Jan](https://docs.openwebui.com/alternatives/jan): _Last updated: August 2026_ - [Open WebUI & LibreChat](https://docs.openwebui.com/alternatives/librechat): _Last updated: August 2026_ - [Open WebUI & llama.cpp](https://docs.openwebui.com/alternatives/llama-cpp): _Last updated: August 2026_ - [Open WebUI & LM Studio](https://docs.openwebui.com/alternatives/lm-studio): _Last updated: August 2026_ - [Open WebUI & Msty](https://docs.openwebui.com/alternatives/msty): _Last updated: August 2026_ - [Open WebUI & Ollama](https://docs.openwebui.com/alternatives/ollama): _Last updated: August 2026_ - [Open WebUI & Onyx](https://docs.openwebui.com/alternatives/onyx): _Last updated: August 2026_ - [Open WebUI Design Guidelines](https://docs.openwebui.com/brand): Welcome to the Open WebUI design guidelines. This document provides the essential rules and recommendations to ensure consistent and clear use of the Open WebUI brand assets. - [Contributing](https://docs.openwebui.com/contributing): **Help build the AI interface everyone deserves.** - [Ecosystem](https://docs.openwebui.com/ecosystem): Open WebUI is the core AI interface and agent control layer. The ecosystem is the set of separate Open WebUI projects that connect to it, complete it, or solve adjacent jobs while... - [Open WebUI Computer](https://docs.openwebui.com/ecosystem/computer): **Your computer, from anywhere.** - [AI in your workspace](https://docs.openwebui.com/ecosystem/computer/ai): There are two ways to put AI in an Open WebUI Computer chat: - [Approvals, plan mode, and review](https://docs.openwebui.com/ecosystem/computer/ai/approvals-and-plan-mode): Every chat has a tool approval mode, set from the **+** menu in the chat input: - [Chat features](https://docs.openwebui.com/ecosystem/computer/ai/chat-features): Quick reference for what the chat input and chat view can do. - [Use your coding agent subscription](https://docs.openwebui.com/ecosystem/computer/ai/coding-agents): Already paying for Codex, Claude Code, Cursor, Grok, OpenCode, Cline, or Pi? Use that subscription as a native chat backend; no API key is needed. Install and log in to the agent'... - [Connect a model (API keys and Ollama)](https://docs.openwebui.com/ecosystem/computer/ai/connect-a-model): Go to **Settings → Admin → Connections** and add a connection. There are exactly two provider types: **OpenAI** and **Anthropic**. There is no separate "Ollama" or "OpenAI-compati... - [Skills and memory](https://docs.openwebui.com/ecosystem/computer/ai/skills-and-memory): A **skill** is a folder with a `SKILL.md` file: a reusable instruction set the AI can pull in on demand ([agentskills.io](https://agentskills.io) spec). **Memory** stores durable... - [Sub-agents](https://docs.openwebui.com/ecosystem/computer/ai/subagents): The AI can delegate work to parallel sub-agents with the `delegate_task` tool. Each sub-agent is a full chat with tool access (it can read files, run commands, and search), and it... - [Voice, speech, and audio](https://docs.openwebui.com/ecosystem/computer/ai/voice-and-audio): Everything audio lives in **Settings → Audio**: speech-to-text, text-to-speech, voice mode, and voice memos. - [Web search and browsing](https://docs.openwebui.com/ecosystem/computer/ai/web-search-and-browsing): Web search works out of the box: with no configuration at all, the AI searches via DuckDuckGo. Browsing (a real browser the AI can navigate and click) is off by default and enable... - [Automation and integrations](https://docs.openwebui.com/ecosystem/computer/automate): Open WebUI Computer keeps working when the browser tab is closed. You can message it from Telegram or Slack, run tasks on a schedule, trigger tasks from other systems with a webho... - [Message your computer](https://docs.openwebui.com/ecosystem/computer/automate/messaging-bots): Connect a bot and your computer answers in Telegram, Discord, Slack, WhatsApp, or Signal: same agent, same workspaces, full tool access. Ask it to check a build, push a fix, or su... - [Notifications and webhooks](https://docs.openwebui.com/ecosystem/computer/automate/notifications): Get pinged without keeping the tab open. Set up a target once in **Settings → Notifications** (a webhook or one of your messaging bots), and there are two ways for messages to rea... - [Use a workspace from Open WebUI](https://docs.openwebui.com/ecosystem/computer/automate/open-webui): Computer's gateway exposes each workspace as an OpenAI-compatible model, so you can select `cptr/` in Open WebUI's model picker and chat with a real machine (files, ter... - [Scheduled tasks](https://docs.openwebui.com/ecosystem/computer/automate/scheduled-tasks): Run a prompt on a schedule: "run the tests every weekday at 9", "summarize new files every Monday", "check the deploy hourly". Each run is a real chat in the workspace you choose,... - [MCP and OpenAPI tool servers](https://docs.openwebui.com/ecosystem/computer/automate/tool-servers): Give the agent tools beyond the built-ins by connecting external tool servers in **Settings → Admin → Tool Servers**. Three server types are supported: - [Computer, Open WebUI, or Open Terminal?](https://docs.openwebui.com/ecosystem/computer/choose): Three tools, three different centers of gravity. Pick by where the work lives, and combine them freely; they're built to. - [FAQ](https://docs.openwebui.com/ecosystem/computer/faq): No. Files, editor, terminal, and git work with zero AI configuration. Add a model whenever you want chat; an API key, Ollama, or a coding-agent subscription all work: [connect a m... - [Installation](https://docs.openwebui.com/ecosystem/computer/install): The fastest install is two commands on the machine you want to serve: - [Air-gapped](https://docs.openwebui.com/ecosystem/computer/install/air-gapped): Open WebUI Computer runs without internet access once installed. The Python wheel bundles the built frontend assets and the Docker image is self-contained, so nothing is fetched a... - [Docker](https://docs.openwebui.com/ecosystem/computer/install/docker): Run Open WebUI Computer from the official image: - [Updating](https://docs.openwebui.com/ecosystem/computer/install/updating): Upgrade with the same tool you installed with, then restart: - [Windows](https://docs.openwebui.com/ecosystem/computer/install/windows): In PowerShell: - [Operate](https://docs.openwebui.com/ecosystem/computer/operate): Keep a long-running Computer instance healthy: know where its data lives, back it up, and check its logs when something looks off. - [Data and backups](https://docs.openwebui.com/ecosystem/computer/operate/data-and-backups): Everything Computer needs to survive a reinstall lives in one data directory: `~/.cptr` by default, `/data` in Docker, or wherever `CPTR_DATA_DIR` points. The one exception is cha... - [Logs, health, and diagnostics](https://docs.openwebui.com/ecosystem/computer/operate/logs-and-health): Is the server up? - [Use it from your phone](https://docs.openwebui.com/ecosystem/computer/phone-and-remote): Open WebUI Computer serves your whole machine to any browser. Your phone is a browser. Pick the route that matches where you are: - [Cloudflare Tunnel and ngrok](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/cloudflare-and-ngrok): Both give you a public URL that forwards to `localhost:8000`: no port forwarding, and the default `cptr run` binding works as-is. Public means anyone who finds the URL reaches you... - [Keep it running](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/keep-it-running): Two different things can stop your work: closing the browser tab (harmless) and the `cptr` process dying (not). Here's how to make the second one stop happening. - [Install the app (PWA)](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/phone-app): Open WebUI Computer is a PWA: install it from the browser and it gets a home-screen icon, opens in its own app window, and shows up in your phone's Share sheet so you can send lin... - [Reverse proxy and SSO](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/reverse-proxy): `cptr` has no TLS of its own: the proxy terminates HTTPS and forwards plain HTTP to `127.0.0.1:8000`. The one thing that trips people up: Computer is Socket.IO-based, so the proxy... - [Security model](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/security): The model in one sentence: **a signed-in user has full access to everything Computer can reach: filesystem and shell, equivalent to an SSH session.** How much that is, you decide... - [Tailscale (recommended)](https://docs.openwebui.com/ecosystem/computer/phone-and-remote/tailscale): Tailscale puts your phone and your computer on a private network of their own. Nothing is exposed to the public internet, there's no port forwarding, and it works from any network... - [Quickstart](https://docs.openwebui.com/ecosystem/computer/quickstart): From zero to your real files in a browser, in about two minutes. You need Python 3.10+ on the machine that has your work (macOS, Linux, or Windows). No AI key, no account with any... - [Reference](https://docs.openwebui.com/ecosystem/computer/reference): Exact flags, variables, config keys, and API behavior, for when you know what you're looking for. - [CLI](https://docs.openwebui.com/ecosystem/computer/reference/cli): The CLI has exactly one command: - [config.toml](https://docs.openwebui.com/ecosystem/computer/reference/configuration): Computer's server configuration lives in `/config.toml`: `~/.cptr/config.toml` by default, `/data/config.toml` in Docker. - [Environment variables](https://docs.openwebui.com/ecosystem/computer/reference/environment-variables): All variables are read once at startup; restart the server to apply a change. - [Gateway API (OpenAI-compatible)](https://docs.openwebui.com/ecosystem/computer/reference/gateway-api): The gateway exposes each of your workspaces as an OpenAI-compatible model, so any OpenAI-style client can run agent tasks in a real workspace. - [Troubleshooting](https://docs.openwebui.com/ecosystem/computer/troubleshooting): Find your symptom below (Ctrl+F works). First check for anything odd: `curl http://127.0.0.1:8000/api/health` tells you whether the server is up at all. - [What people actually do with it](https://docs.openwebui.com/ecosystem/computer/use-cases): Thirteen real workflows, written as steps you can follow today, from "I've never opened a terminal" to "I'm running three agents in parallel." Each one says what to set up first a... - [A project folder that follows you](https://docs.openwebui.com/ecosystem/computer/use-cases/a-folder-that-follows-you): A thesis chapter, a research project, a zine: twelve PDFs, a pile of notes, screenshots from your phone, and ideas that arrive on the bus. None of this needs a terminal or git. It... - [An agent that learns how you work](https://docs.openwebui.com/ecosystem/computer/use-cases/an-agent-that-learns-your-way): The third time you explain your release process to the AI, something should change. Not the model; the setup. The difference between a chatbot and a colleague is that a colleague... - [An assistant that texts you first](https://docs.openwebui.com/ecosystem/computer/use-cases/an-assistant-that-texts-first): 7:45 on a Tuesday. Your phone buzzes with a Telegram message from your own computer: - [Clean up a messy folder with AI](https://docs.openwebui.com/ecosystem/computer/use-cases/clean-up-a-messy-folder): Your Downloads folder has 400 files in it: screenshots named `Screen Shot 2025-11-03 at 9.41.12 PM.png`, six copies of the same PDF, homework from two school years, and installers... - [Delegate a whole job, come back to a deliverable](https://docs.openwebui.com/ecosystem/computer/use-cases/delegate-a-whole-job): Your team needs to pick a city for the offsite: 20 people, three candidate cities, flights, venues, visa quirks, a budget ceiling. That's an afternoon of tabs and a spreadsheet. O... - [Build your first website with an AI beside you](https://docs.openwebui.com/ecosystem/computer/use-cases/first-website): You want a website: a page for your club, a portfolio for art class, a fan page, whatever. You've never written HTML. The usual advice is a website builder that owns your page, or... - [Ship a fix from your phone](https://docs.openwebui.com/ecosystem/computer/use-cases/fix-from-your-phone): A user reports that the signup form rejects valid emails. You're on a train. The repo, the branch you were working on, and the dev database are all on the machine at your desk. In... - [Message your computer from Telegram](https://docs.openwebui.com/ecosystem/computer/use-cases/message-your-computer): You're out, and you want to know whether the build you kicked off actually passed, without opening a laptop or even a browser tab. So you text your computer like it's a person: - [Give Open WebUI real hands](https://docs.openwebui.com/ecosystem/computer/use-cases/open-webui-hands): Open WebUI is where you already chat: your models, your prompts, your history. But when you ask it "what does our rate limiter actually do?", a plain model can only guess. Connect... - [Run parallel agents on git worktrees](https://docs.openwebui.com/ecosystem/computer/use-cases/parallel-agents-on-worktrees): You have three independent tasks queued on one repo: a flaky-test fix, a dependency bump with API fallout, and a docs pass. One agent doing them sequentially wastes the parallelis... - [A morning check that reports to you](https://docs.openwebui.com/ecosystem/computer/use-cases/scheduled-morning-checks): Every morning you run the test suite on the side project before work, skim the output, and forget about it. That's a job for a schedule: run the tests at 7:30, and only make noise... - [Supervise a coding agent from anywhere](https://docs.openwebui.com/ecosystem/computer/use-cases/supervise-a-coding-agent): Before leaving the house you asked Claude Code to migrate the settings module off a deprecated API. Somewhere around lunch it reaches the part you were worried about: the database... - [Test your dev server on a real phone](https://docs.openwebui.com/ecosystem/computer/use-cases/test-on-a-real-device): The checkout flow looks perfect in Chrome's device emulator. It also looked perfect last time, right up until a real iPhone keyboard covered the submit button. Emulators don't hav... - [What is Computer?](https://docs.openwebui.com/ecosystem/computer/what-is-computer): Your computer has always been a _place_. You go to it, sit down, work, walk away, and everything on it sits frozen until you come back. - [Your workspace](https://docs.openwebui.com/ecosystem/computer/workspace): A workspace is a real folder on the machine running Open WebUI Computer, not an upload or a copy. Point Computer at `/Users/you/src/project` and you get that actual directory: its... - [Files and editor](https://docs.openwebui.com/ecosystem/computer/workspace/files-and-editor): The file browser shows the workspace folder as it exists on disk. Browse the tree, type in the filter to narrow it, and use the breadcrumb to move back up. Files show recognizable... - [Git](https://docs.openwebui.com/ecosystem/computer/workspace/git): When the workspace is a git repository, a git status strip shows the current branch and the changed files, with added and removed line counts per file. Expand it to stage, diff, c... - [Notes, memos, and sharing](https://docs.openwebui.com/ecosystem/computer/workspace/notes-and-sharing): Workspaces aren't just for code. Notes, recordings, and things you send in from other apps all land as real files in the project folder: searchable, versionable, and visible to th... - [Preview local apps and browse](https://docs.openwebui.com/ecosystem/computer/workspace/previews-and-browser): Two ways to get a web page next to your work: a **port preview** opens a dev server that's running on the host, and a **browser tab** opens any URL. Both live in the same tab-and-... - [Search and chats](https://docs.openwebui.com/ecosystem/computer/workspace/search-and-chats): Press `Cmd+K` (`Ctrl+K` on Windows/Linux) to search. With a workspace active, results are scoped to it: file names, chats, and the messages inside them. `Cmd+Shift+F` opens the br... - [Terminals](https://docs.openwebui.com/ecosystem/computer/workspace/terminals): Open a terminal tab and you get a full PTY-backed shell on the host, starting in the workspace folder. It's your real shell: your PATH, your credentials, your tools. Anything you'... - [Add and switch workspaces](https://docs.openwebui.com/ecosystem/computer/workspace/workspaces): Open the workspace picker in the sidebar and add any folder on the host by its absolute path, for example `/Users/you/src/project`. You can also create a new folder directly from... - [Knowledge Base Sync (oikb)](https://docs.openwebui.com/ecosystem/knowledge-base-sync): **Keep a Knowledge Base in sync with the source of truth, automatically.** - [Running the daemon](https://docs.openwebui.com/ecosystem/knowledge-base-sync/daemon): The CLI on the [main page](/ecosystem/knowledge-base-sync) covers one-off and watched syncs. For anything unattended, scheduled or driven by external events, run oikb as a long-li... - [Open Terminal & Terminals](https://docs.openwebui.com/ecosystem/open-terminal): **Turn Open WebUI into a full agent harness: the control layer, the action layer, and the feedback loop between them.** - [Open WebUI for Enterprise](https://docs.openwebui.com/enterprise): Open WebUI is one of the **fastest-growing AI platforms** in the world. Designed for **enterprise deployment**, Open WebUI enables businesses to deploy AI capabilities with **full... - [Architecture & High Availability](https://docs.openwebui.com/enterprise/architecture): When AI becomes central to your organization's operations, downtime isn't just inconvenient, it's costly. Open WebUI is architected from the ground up to support enterprise-scale... - [Customer Stories](https://docs.openwebui.com/enterprise/customers): Open WebUI is the interface of choice for individuals, engineering teams, researchers, and enterprises worldwide. With thousands of active deployments, it powers AI initiatives ac... - [Astellas Employees Build 420+ Custom AI Models on a Secure, Self-Hosted Platform with Open WebUI](https://docs.openwebui.com/enterprise/customers/astellas-pharma): ![Astellas Pharma Inc.](/assets/images/hero-e656cfab5a28ed6a72299905cfe3c2f2.png) - [Public Storage Scales a Secure, Champion-Driven AI Platform Across Every Corporate Function With Open WebUI](https://docs.openwebui.com/enterprise/customers/public-storage): ![Public Storage](/assets/images/hero-b23e3f3f1d3ca391e9cefd556c10ab63.png) - [Samsung Semiconductor Accelerates R&D With Private, On-Prem AI Platform Powered by Open WebUI](https://docs.openwebui.com/enterprise/customers/samsung-semiconductor): ![Samsung Semiconductor, Inc.](/assets/images/hero-75c6982dac2fbba774df762bb0690692.png) - [Customization](https://docs.openwebui.com/enterprise/customization): For organizations deploying AI tools to internal teams, or offering AI capabilities to clients, brand consistency matters. Open WebUI's enterprise licensing enables full white-lab... - [Scalable Enterprise Deployment Options](https://docs.openwebui.com/enterprise/deployment): 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 se... - [Container Service](https://docs.openwebui.com/enterprise/deployment/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. - [Kubernetes with Helm](https://docs.openwebui.com/enterprise/deployment/kubernetes-helm): Deploy using the official Open WebUI Helm chart on any Kubernetes distribution (EKS, AKS, GKE, OpenShift, Rancher, self-managed). - [Python / Pip on Auto-Scaling VMs](https://docs.openwebui.com/enterprise/deployment/python-pip): Deploy `open-webui serve` as a systemd-managed process on virtual machines in a cloud auto-scaling group (AWS ASG, Azure VMSS, GCP MIG). - [Integration](https://docs.openwebui.com/enterprise/integration): Off-the-shelf software rarely fits enterprise workflows perfectly. Teams have established processes, specific model requirements, and brand standards that generic tools can't acco... - [Partners & Agencies](https://docs.openwebui.com/enterprise/partners): We carefully select our partners to maintain the highest standards and provide the best experience to our community. - [Security](https://docs.openwebui.com/enterprise/security): For enterprise organizations, AI adoption isn't just a technology decision, it's a security decision. Every model query, every document uploaded, and every workflow automated repr... - [Sovereign AI Platform](https://docs.openwebui.com/enterprise/sovereign-ai): Sovereign AI is the ability to decide where AI runs, what data it can reach, which model endpoints it can use, who can access it, and how the system is governed over time. - [Support & SLAs](https://docs.openwebui.com/enterprise/support): Open WebUI's enterprise solutions provide mission-critical businesses with **dedicated support and direct access** to the team behind the platform. Support engagements are structu... - [FAQ](https://docs.openwebui.com/faq): **A:** Community support for Open WebUI happens in public channels with help from contributors, volunteers, and members of the core team. These channels are best for shared troubl... - [What You Can Do with Open WebUI](https://docs.openwebui.com/features): **One interface for every AI model. Private, extensible, and built for teams.** - [Administration](https://docs.openwebui.com/features/administration): **Monitor usage, evaluate model quality, and communicate with your users, all from the Admin Panel.** - [Analytics](https://docs.openwebui.com/features/administration/analytics): The **Analytics** feature in Open WebUI provides administrators with comprehensive insights into usage patterns, token consumption, and model performance across their instance. Th... - [Customizable Banners](https://docs.openwebui.com/features/administration/banners): Open WebUI allows administrators to display custom banners to logged-in users. Banners are useful for announcements, system-wide alerts, maintenance notices, and other important m... - [Evaluation](https://docs.openwebui.com/features/administration/evaluation): Meet **Alex**, a machine learning engineer at a mid-sized company. Alex knows there are numerous AI models out there (GPT, Claude, Gemini, Qwen, and many more) but which one works... - [Webhook Integrations](https://docs.openwebui.com/features/administration/webhooks): Open WebUI offers three distinct webhook integrations to help you stay informed about events happening within your instance and enable external integrations. These webhooks allow... - [Authentication & Access](https://docs.openwebui.com/features/authentication-access): **Control who gets in, what they can do, and how your instance integrates with your identity stack.** - [API Keys](https://docs.openwebui.com/features/authentication-access/api-keys): **Programmatic access to Open WebUI, for scripts, bots, and integrations.** - [OpenLDAP Integration](https://docs.openwebui.com/features/authentication-access/auth/ldap): This guide provides a comprehensive walkthrough for setting up OpenLDAP authentication with Open WebUI. It covers creating a test OpenLDAP server using Docker, seeding it with sam... - [SCIM 2.0 Support](https://docs.openwebui.com/features/authentication-access/auth/scim): Open WebUI supports SCIM 2.0 (System for Cross-domain Identity Management) for automated user and group provisioning from identity providers like Okta, Azure AD, and Google Worksp... - [SSO (OAuth, OIDC, Trusted Header)](https://docs.openwebui.com/features/authentication-access/auth/sso): > **info** - [Keycloak](https://docs.openwebui.com/features/authentication-access/auth/sso/keycloak): > **warning** - [Role-Based Access Control (RBAC)](https://docs.openwebui.com/features/authentication-access/rbac): Open WebUI implements a flexible and secure **Role-Based Access Control (RBAC)** system. This system allows administrators to precisely manage user capabilities and access to reso... - [Groups](https://docs.openwebui.com/features/authentication-access/rbac/groups): Groups in Open WebUI are a powerful mechanism for organizing users and managing access control at scale. They serve two primary purposes: - [Permissions](https://docs.openwebui.com/features/authentication-access/rbac/permissions): Open WebUI provides a flexible permissions system that allows administrators to configure access controls and feature availability for users. This enables fine-grained control ove... - [Roles](https://docs.openwebui.com/features/authentication-access/rbac/roles): Open WebUI defines three primary **System Roles** that determine the fundamental access level of a user account. These roles are distinct from [Groups](/features/authentication-ac... - [Calendar](https://docs.openwebui.com/features/calendar): **Schedule, track, and manage events, with AI that can plan for you.** - [Channels](https://docs.openwebui.com/features/channels): **Where your team and AI think together, in real time.** - [Chat & Conversations](https://docs.openwebui.com/features/chat-conversations): **The conversation is the heart of Open WebUI, and it does far more than trade messages.** - [Audio](https://docs.openwebui.com/features/chat-conversations/audio): ![Speech to text and text to speech settings](/assets/images/admin-audio-379891ccf7eb682e6a3f05087ffab248.png) - [Environment Variables](https://docs.openwebui.com/features/chat-conversations/audio/speech-to-text/env-variables): > **info** - [Using Mistral Voxtral for Speech-to-Text](https://docs.openwebui.com/features/chat-conversations/audio/speech-to-text/mistral-voxtral-integration): This guide covers how to use Mistral's Voxtral model for Speech-to-Text with Open WebUI. Voxtral is Mistral's speech-to-text model that provides accurate transcription. - [Using OpenAI for Speech-to-Text](https://docs.openwebui.com/features/chat-conversations/audio/speech-to-text/openai-stt-integration): This guide covers how to use OpenAI's Whisper API for Speech-to-Text with Open WebUI. This provides cloud-based transcription without needing local GPU resources. - [Configuration](https://docs.openwebui.com/features/chat-conversations/audio/speech-to-text/stt-config): Open WebUI supports both local, browser, and remote speech to text. - [Chatterbox TTS: Voice Cloning](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/chatterbox-tts-api-integration): > **warning** - [Kokoro-FastAPI Using Docker](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/Kokoro-FastAPI-integration): > **warning** - [Kokoro Web - Effortless TTS for Open WebUI](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/kokoro-web-integration): > **warning** - [Using Mistral for Text-to-Speech](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/mistral-tts-integration): This guide covers how to use Mistral's Text-to-Speech API with Open WebUI. - [Integrating openai-edge-tts with Open WebUI](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/openai-edge-tts-integration): > **warning** - [Using OpenAI for Text-to-Speech](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/openai-tts-integration): This guide covers how to use OpenAI's official Text-to-Speech API with Open WebUI. This is the simplest setup if you already have an OpenAI API key. - [Openedai-speech Using Docker](https://docs.openwebui.com/features/chat-conversations/audio/text-to-speech/openedai-speech-integration): > **warning** - [Chat Features Overview](https://docs.openwebui.com/features/chat-conversations/chat-features): Open WebUI provides a comprehensive set of chat features designed to enhance your interactions with AI models. This page provides an overview of the key chat capabilities, with li... - [Autocomplete](https://docs.openwebui.com/features/chat-conversations/chat-features/autocomplete): Open WebUI offers an **AI-powered Autocomplete** feature that suggests text completions in real-time as you type your prompt. It acts like a "Copilot" for your chat input, helping... - [Automations](https://docs.openwebui.com/features/chat-conversations/chat-features/automations): Automations let you schedule prompts to run automatically at recurring times. Each run creates a chat and executes through the normal chat completion pipeline, so model defaults,... - [Chat Parameters](https://docs.openwebui.com/features/chat-conversations/chat-features/chat-params): Within Open WebUI, there are three levels to setting a **System Prompt** and **Advanced Parameters**: per-chat basis, per-model basis, and per-account basis. This hierarchical sys... - [Chat Sharing](https://docs.openwebui.com/features/chat-conversations/chat-features/chatshare): To enable community sharing, follow these steps: - [Code Execution](https://docs.openwebui.com/features/chat-conversations/chat-features/code-execution): Open WebUI offers powerful code execution capabilities directly within your chat interface, enabling you to transform ideas into actionable results without leaving the platform. - [Artifacts](https://docs.openwebui.com/features/chat-conversations/chat-features/code-execution/artifacts): Artifacts in Open WebUI are an innovative feature inspired by Claude.AI's Artifacts, allowing you to interact with significant and standalone content generated by an LLM within a... - [MermaidJS Rendering](https://docs.openwebui.com/features/chat-conversations/chat-features/code-execution/mermaid): Open WebUI supports rendering of visually appealing MermaidJS diagrams, flowcharts, pie charts and more, directly within the chat interface. MermaidJS is a powerful tool for visua... - [Python Code Execution](https://docs.openwebui.com/features/chat-conversations/chat-features/code-execution/python): Open WebUI provides two ways to execute Python code: - [Folders & Projects](https://docs.openwebui.com/features/chat-conversations/chat-features/conversation-organization): Open WebUI provides powerful folder-based organization that turns simple chat containers into full-featured **project workspaces**. Folders allow you to not only group related con... - [Follow-Up Prompts](https://docs.openwebui.com/features/chat-conversations/chat-features/follow-up-prompts): Open WebUI can automatically generate follow-up question suggestions after each model response. These suggestions appear as clickable chips below the response, helping you explore... - [History & Search](https://docs.openwebui.com/features/chat-conversations/chat-features/history-search): Open WebUI provides a powerful system for managing and navigating your previous conversations. Whether you are looking for a specific snippet of code from last month or trying to... - [Keyboard Shortcuts](https://docs.openwebui.com/features/chat-conversations/chat-features/keyboard-shortcuts): Open WebUI ships with keyboard shortcuts for the things you do constantly, and most of them can be **rebound to keys you prefer**. Shortcuts are per user and stored with your sett... - [Message Queue](https://docs.openwebui.com/features/chat-conversations/chat-features/message-queue): The **Message Queue** feature allows you to continue composing and sending messages while the AI is still generating a response. Instead of blocking your input until the current r... - [Multi-Model Chats](https://docs.openwebui.com/features/chat-conversations/chat-features/multi-model-chats): Open WebUI allows you to interact with **multiple models simultaneously** within a single chat interface. This powerful feature enables you to compare responses, verify facts, and... - [Notifications](https://docs.openwebui.com/features/chat-conversations/chat-features/notifications): Notifications send a webhook to somewhere you actually watch, such as Slack, Discord or your own endpoint, when something happens in Open WebUI that you care about. Each user sets... - [Reasoning & Thinking Models](https://docs.openwebui.com/features/chat-conversations/chat-features/reasoning-models): Open WebUI provides first-class support for models that exhibit "thinking" or "reasoning" behaviors (such as DeepSeek R1, OpenAI o1, and others). These models often generate inter... - [Sub-agents](https://docs.openwebui.com/features/chat-conversations/chat-features/subagents): Sub-agents let a model hand a focused piece of work to a second agent that runs in parallel, then use the result to continue. The model decides when to delegate by calling the `de... - [Task Management](https://docs.openwebui.com/features/chat-conversations/chat-features/task-management): Task Management gives agentic models a structured way to plan and track multi-step work in a chat. Instead of keeping an implicit plan in free text, the model can maintain a live... - [Temporal Awareness (Date & Time)](https://docs.openwebui.com/features/chat-conversations/chat-features/temporal-awareness): For an AI to be truly helpful, it needs to understand the concept of time. Open WebUI provides models with the current date, time, and timezone so they can deliver contextually re... - [Timers](https://docs.openwebui.com/features/chat-conversations/chat-features/timers): Timers let a model come back to you later. The model calls the `timer` builtin tool with a prompt and a time, and when that time arrives the prompt is sent back into the same chat... - [URL Parameters](https://docs.openwebui.com/features/chat-conversations/chat-features/url-params): In Open WebUI, chat sessions can be customized through various URL parameters. These parameters allow you to set specific configurations, enable features, and define model setting... - [Data Controls](https://docs.openwebui.com/features/chat-conversations/data-controls): The **Data Controls** section in Open WebUI provides tools for managing your personal data, including files, shared content, and chat history. Access it via **Settings > Data Cont... - [Archived Chats](https://docs.openwebui.com/features/chat-conversations/data-controls/archived-chats): Open WebUI allows you to archive conversations to declutter your sidebar while preserving them for future reference. The **Archived Chats** dashboard lets you manage all your arch... - [File Management](https://docs.openwebui.com/features/chat-conversations/data-controls/files): Open WebUI provides a comprehensive file management system that allows you to upload, organize, and utilize your documents across various features like Knowledge Bases and RAG. - [Import & Export](https://docs.openwebui.com/features/chat-conversations/data-controls/import-export): Open WebUI provides tools to backup your chat history and restore it later, or migrate conversations from other platforms. - [Shared Chats](https://docs.openwebui.com/features/chat-conversations/data-controls/shared-chats): Open WebUI provides a centralized dashboard to manage every chat conversation you have shared. This feature allows users to audit their shared content and quickly revoke access if... - [Direct Connections](https://docs.openwebui.com/features/chat-conversations/direct-connections): > **Experimental Feature** - [Image Generation](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing): ![Image generation settings](/assets/images/admin-images-92b08e4f67a197bcf3ed7b2acf249f78.png) - [AUTOMATIC1111](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/automatic1111): > **warning** - [ComfyUI](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/comfyui): > **warning** - [Gemini](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/gemini): > **warning** - [Image Router](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/image-router): > **warning** - [Lumenfall](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/lumenfall): > **warning** - [OpenAI](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/openai): > **warning** - [Usage](https://docs.openwebui.com/features/chat-conversations/image-generation-and-editing/usage): Image generation is only available in a chat when all of the following are true: - [Memory & Personalization](https://docs.openwebui.com/features/chat-conversations/memory): > **Model-dependent quality** - [Prompt Caching (KV Cache) Optimization](https://docs.openwebui.com/features/chat-conversations/prompt-caching): Most hosted LLM providers cache the KV state of a request's **prefix**. When two requests share an identical leading sequence of tokens, the provider serves the shared part from c... - [Retrieval Augmented Generation (RAG)](https://docs.openwebui.com/features/chat-conversations/rag): > **warning** - [Document Extraction](https://docs.openwebui.com/features/chat-conversations/rag/document-extraction): Open WebUI provides powerful document extraction capabilities that allow you to process and analyze various types of documents within your RAG (Retrieval Augmented Generation) wor... - [Apache Tika Extraction](https://docs.openwebui.com/features/chat-conversations/rag/document-extraction/apachetika): > **warning** - [Docling Document Extraction](https://docs.openwebui.com/features/chat-conversations/rag/document-extraction/docling): > **warning** - [Mistral OCR](https://docs.openwebui.com/features/chat-conversations/rag/document-extraction/mistral-ocr): > **warning** - [Web Search](https://docs.openwebui.com/features/chat-conversations/web-search): ![Web search settings](/assets/images/admin-web-search-80d720ed6e621925b75f849577c6670c.png) - [Agentic Web Search & URL Fetching](https://docs.openwebui.com/features/chat-conversations/web-search/agentic-search): Open WebUI's web search has evolved from simple result injection to a fully **agentic research system**. By enabling **Native Function Calling (Agentic Mode)**, you allow quality... - [Bing](https://docs.openwebui.com/features/chat-conversations/web-search/providers/bing): > **warning** - [Brave](https://docs.openwebui.com/features/chat-conversations/web-search/providers/brave): > **warning** - [DDGS](https://docs.openwebui.com/features/chat-conversations/web-search/providers/ddgs): > **warning** - [Exa AI Web Search Integration](https://docs.openwebui.com/features/chat-conversations/web-search/providers/exa): > **warning** - [External](https://docs.openwebui.com/features/chat-conversations/web-search/providers/external): > **warning** - [Firecrawl](https://docs.openwebui.com/features/chat-conversations/web-search/providers/firecrawl): > **warning** - [Google PSE](https://docs.openwebui.com/features/chat-conversations/web-search/providers/google-pse): > **warning** - [Jina Web Search Integration](https://docs.openwebui.com/features/chat-conversations/web-search/providers/jina): > **warning** - [Kagi](https://docs.openwebui.com/features/chat-conversations/web-search/providers/kagi): > **warning** - [Linkup](https://docs.openwebui.com/features/chat-conversations/web-search/providers/linkup): > **warning** - [Microsoft Web IQ](https://docs.openwebui.com/features/chat-conversations/web-search/providers/microsoft-web-iq): > **warning** - [Mojeek](https://docs.openwebui.com/features/chat-conversations/web-search/providers/mojeek): > **warning** - [Ollama Cloud Web Search](https://docs.openwebui.com/features/chat-conversations/web-search/providers/ollama-cloud): > **warning** - [OpenSERP](https://docs.openwebui.com/features/chat-conversations/web-search/providers/openserp): [OpenSERP](https://github.com/karust/openserp) is a self-hosted scraper that returns results from several major search engines. Like [SearXNG](/features/chat-conversations/web-sea... - [Perplexity](https://docs.openwebui.com/features/chat-conversations/web-search/providers/perplexity): > **warning** - [Perplexity Search](https://docs.openwebui.com/features/chat-conversations/web-search/providers/perplexity_search): > **warning** - [SearchApi](https://docs.openwebui.com/features/chat-conversations/web-search/providers/searchapi): > **warning** - [SearXNG](https://docs.openwebui.com/features/chat-conversations/web-search/providers/searxng): > **warning** - [SerpApi](https://docs.openwebui.com/features/chat-conversations/web-search/providers/serpapi): > **warning** - [Serper](https://docs.openwebui.com/features/chat-conversations/web-search/providers/serper): > **warning** - [SERPHouse](https://docs.openwebui.com/features/chat-conversations/web-search/providers/serphouse): > **warning** - [Serply](https://docs.openwebui.com/features/chat-conversations/web-search/providers/serply): > **warning** - [Serpstack](https://docs.openwebui.com/features/chat-conversations/web-search/providers/serpstack): > **warning** - [Tavily](https://docs.openwebui.com/features/chat-conversations/web-search/providers/tavily): > **warning** - [Yacy](https://docs.openwebui.com/features/chat-conversations/web-search/providers/yacy): > **warning** - [Yandex](https://docs.openwebui.com/features/chat-conversations/web-search/providers/yandex): > **warning** - [You.com](https://docs.openwebui.com/features/chat-conversations/web-search/providers/youcom): > **warning** - [Save Search Results to Knowledge](https://docs.openwebui.com/features/chat-conversations/web-search/save-to-knowledge): The **Add Web Sources to Knowledge Action** allows you to save web search result URLs directly to your Knowledge Base with a single click. This feature streamlines the process of... - [Extensibility](https://docs.openwebui.com/features/extensibility): **Make Open WebUI do anything with Python, HTTP, or community plugins you install in one click.** - [Community Plugins](https://docs.openwebui.com/features/extensibility/community): The [Open WebUI Community site](https://openwebui.com/) hosts hundreds of community-built Tools and Functions you can import into your instance in one click. This page is a beginn... - [Model Context Protocol (MCP)](https://docs.openwebui.com/features/extensibility/mcp): 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... - [Pipelines: UI-Agnostic OpenAI API Plugin Framework](https://docs.openwebui.com/features/extensibility/pipelines): [![Pipelines Logo](/assets/images/header-0c6d20373101a0da43c3682a6f5a3baf.png)](#) - [Filters](https://docs.openwebui.com/features/extensibility/pipelines/filters): > **Pipelines are legacy, do not use for new deployments** - [Pipes](https://docs.openwebui.com/features/extensibility/pipelines/pipes): > **Pipelines are legacy, do not use for new deployments** - [Tutorials](https://docs.openwebui.com/features/extensibility/pipelines/tutorials): > **Pipelines are legacy, do not use for new deployments** - [Valves](https://docs.openwebui.com/features/extensibility/pipelines/valves): > **Pipelines are legacy, do not use for new deployments** - [Tools & Functions](https://docs.openwebui.com/features/extensibility/plugin): > **⚠️ Critical Security Warning** - [Events: Using eventemitter and eventcall in Open WebUI](https://docs.openwebui.com/features/extensibility/plugin/development/events): Open WebUI's plugin architecture is not just about processing input and producing output: **it's about real-time, interactive communication with the UI and users**. To make your T... - [Special Arguments](https://docs.openwebui.com/features/extensibility/plugin/development/reserved-args): > **warning** - [Rich UI Element Embedding](https://docs.openwebui.com/features/extensibility/plugin/development/rich-ui): Tools and Actions both support rich UI element embedding, allowing them to return HTML content and interactive iframes that display directly within chat conversations. This featur... - [Under the Hood: What the Plugin Loader Actually Does](https://docs.openwebui.com/features/extensibility/plugin/development/under-the-hood): > **⚠️ Critical Security Warning** - [Valves](https://docs.openwebui.com/features/extensibility/plugin/development/valves): Valves and UserValves are used to allow users to provide dynamic details such as an API key or a configuration option. These will create a fillable field or a bool switch in the G... - [Functions](https://docs.openwebui.com/features/extensibility/plugin/functions): > **⚠️ Critical Security Warning** - [Action Function: Custom Interactive Buttons](https://docs.openwebui.com/features/extensibility/plugin/functions/action): > **⚠️ Critical Security Warning** - [Event Function: React to System Events](https://docs.openwebui.com/features/extensibility/plugin/functions/event): > **New in 0.10.0** - [Filter Function: Modify Inputs and Outputs](https://docs.openwebui.com/features/extensibility/plugin/functions/filter): > **⚠️ Critical Security Warning** - [Pipe Function: Create Custom"Agents/Models"](https://docs.openwebui.com/features/extensibility/plugin/functions/pipe): > **⚠️ Critical Security Warning** - [Plugin Migration Guides](https://docs.openwebui.com/features/extensibility/plugin/migration): Open WebUI occasionally ships releases that require updates to existing Tools, Functions, Pipes, Filters, and Actions. This section collects the per-version migration guides for p... - [Migration Guide: Open WebUI 0.4 to 0.5](https://docs.openwebui.com/features/extensibility/plugin/migration/to-0.5.0): Welcome to the Open WebUI 0.5 migration guide! If you're working on existing projects or building new ones, this guide will walk you through the key changes from **version 0.4 to... - [Migration Guide: Upgrading to Open WebUI 0.9.0](https://docs.openwebui.com/features/extensibility/plugin/migration/to-0.9.0): This guide covers breaking changes and required updates for Tools, Functions, Pipes, Filters, and Actions when upgrading to **Open WebUI 0.9.0**. - [What are Tools?](https://docs.openwebui.com/features/extensibility/plugin/tools): > **⚠️ Critical Security Warning** - [Tool Development](https://docs.openwebui.com/features/extensibility/plugin/tools/development): > **⚠️ Critical Security Warning** - [OpenAPI Tool Servers](https://docs.openwebui.com/features/extensibility/plugin/tools/openapi-servers): This repository provides reference OpenAPI Tool Server implementations making it easy and secure for developers to integrate external tooling and data sources into LLM agents and... - [FAQ](https://docs.openwebui.com/features/extensibility/plugin/tools/openapi-servers/faq): **A:** If you added the server under your own **Settings → Integrations**, the browser calls it directly, so a tool server on `http://localhost:8000` is subject to CORS (Cross-Ori... - [MCP Support](https://docs.openwebui.com/features/extensibility/plugin/tools/openapi-servers/mcp): This documentation explains how to easily set up and deploy the [**MCP (Model Context Protocol)-to-OpenAPI proxy server** (mcpo)](https://github.com/open-webui/mcpo) provided by O... - [Open WebUI Integration](https://docs.openwebui.com/features/extensibility/plugin/tools/openapi-servers/open-webui): Open WebUI v0.6+ supports seamless integration with external tools via the OpenAPI servers, meaning you can easily extend your LLM workflows using custom or community-powered tool... - [Notes](https://docs.openwebui.com/features/notes): **Write, think, and refine with AI by your side.** - [Open Terminal](https://docs.openwebui.com/features/open-terminal): **Turn Open WebUI into a full agent harness.** - [Configuration Reference](https://docs.openwebui.com/features/open-terminal/advanced/configuration): Open Terminal has sensible defaults out of the box. This page covers all the settings you can customize if you need to. - [Setting Up Open Terminal for a Team](https://docs.openwebui.com/features/open-terminal/advanced/multi-user): When multiple people on your team need terminal access through Open WebUI, you have two options. - [Security Best Practices](https://docs.openwebui.com/features/open-terminal/advanced/security): Open Terminal gives AI real power to run commands and manage files. Here's how to make sure that power is used safely. - [The File Browser](https://docs.openwebui.com/features/open-terminal/file-browser): When Open Terminal is connected, a **file browser** appears in the sidebar of your chat. It works like the file explorer on your computer. You can browse folders, open files, uplo... - [Connecting Open Terminal to Open WebUI](https://docs.openwebui.com/features/open-terminal/setup/connecting): Open Terminal is [installed and running](/features/open-terminal/setup/installation). This guide covers connecting it to Open WebUI. - [Installation](https://docs.openwebui.com/features/open-terminal/setup/installation): Choose an installation method based on your needs: - [Terminals (Orchestrator)](https://docs.openwebui.com/features/open-terminal/terminals): **Terminals** is the enterprise orchestration layer for [Open Terminal](/features/open-terminal). It provisions a dedicated computer substrate for every Open WebUI user: separate... - [Orchestration](https://docs.openwebui.com/features/open-terminal/terminals/orchestration): The Terminals orchestrator gives each Open WebUI user a dedicated agent workspace backed by Open Terminal. Open WebUI stores the connection, the orchestrator resolves policy, and... - [API and Troubleshooting](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/api-troubleshooting): All orchestrator policy and lifecycle endpoints require: - [Applying Changes](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/applying-changes): Policy changes apply when a terminal is newly provisioned. They do not rewrite a container that is already running. - [Custom Images](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/custom-images): For small package changes, prefer `OPEN_TERMINAL_PACKAGES`, `OPEN_TERMINAL_PIP_PACKAGES`, or `OPEN_TERMINAL_NPM_PACKAGES`. - [Environment Variables](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/environment-variables): Policy environment variables are passed into the per-user Open Terminal container. They are raw strings, not shell commands. - [File Browser Root](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/file-browser-home-boundary): Open Terminal reports a file-browser root through `GET /files/cwd`: - [OpenShift](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/openshift): Terminals can run on OpenShift as a restricted per-user terminal sandbox. - [Policies](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/policies): A policy describes what a user's Open Terminal workspace should look like. It controls the image, tools, resources, storage, environment variables, security context, and idle time... - [Scheduled Resets](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/scheduled-resets): Each orchestrated terminal can keep persisted files across idle cleanup and container recreation. - [System Prompts](https://docs.openwebui.com/features/open-terminal/terminals/orchestration/system-prompts): Open Terminal provides a generated system prompt by default. It includes runtime details such as operating system, kernel, architecture, hostname, user, shell, and Python version. - [Advanced Workflows with Skills](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows): These workflows combine multiple Open Terminal capabilities into powerful multi-step pipelines. Each one includes a **Skill**, a reusable set of instructions you create in Open We... - [Build a Complete Application](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/app-builder): Describe what you want and get a working app with frontend, backend, and database. - [Automated Code Review](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/code-review): Point the AI at a pull request, a branch diff, or a file, and get a detailed code review: security issues, performance problems, style violations, and suggestions for improvement. - [Competitive Analysis](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/competitive-analysis): Scrape competitor pricing pages and build a comparison. - [Turn Raw Data into a Polished Report](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/data-reports): Upload messy data, and the AI cleans it, analyzes it, builds charts, and produces a downloadable PDF report. - [Connect to a Database and Analyze It](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/database-analysis): Connect to your PostgreSQL, MySQL, or SQLite database directly and let the AI explore the schema, run queries, and produce insights, all without writing SQL yourself. - [Compare Two Versions of a Document](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/document-comparison): Upload two versions of a contract or proposal and get a clear summary of what changed. - [Process a Folder of Emails](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/email-processing): Drop a batch of `.eml` files and get a structured spreadsheet with action items and deadlines. - [Personal Finance Dashboard](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/finance-dashboard): Upload bank statements and get a spending analysis with charts. - [Batch Process Images](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/image-processing): Resize, watermark, convert, or generate thumbnails for a folder of images. - [Research and Summarize Any Topic](https://docs.openwebui.com/features/open-terminal/use-cases/advanced-workflows/research-assistant): Give the AI a question, and it gathers information from the web, organizes it, and writes a structured briefing. - [Code Execution](https://docs.openwebui.com/features/open-terminal/use-cases/code-execution): Open Terminal allows the AI to write, execute, and debug code in real time. It handles the full cycle: writing the script, running it, reading errors, and iterating until the resu... - [Analyze Your Documents and Data](https://docs.openwebui.com/features/open-terminal/use-cases/file-analysis): Got a pile of spreadsheets, PDFs, Word documents, or emails you need to make sense of? Drop them into the file browser and let the AI read them for you. Open Terminal can open and... - [Software Development](https://docs.openwebui.com/features/open-terminal/use-cases/software-development): Open Terminal enables the AI to interact with real codebases: cloning repos, running tests, reading errors, installing dependencies, and iterating on fixes. - [Automate Tasks](https://docs.openwebui.com/features/open-terminal/use-cases/system-automation): Open Terminal isn't just for code. The AI can manage files, organize folders, process data in bulk, handle backups, and automate repetitive work, all from a conversation. - [Build and Preview Websites](https://docs.openwebui.com/features/open-terminal/use-cases/web-development): One of the most impressive things Open Terminal can do: the AI builds a website, starts a server, and you **see it live in a preview panel**, all inside Open WebUI. Then you tell... - [Workspace](https://docs.openwebui.com/features/workspace): **Compose your own AI from five building blocks.** - [Knowledge](https://docs.openwebui.com/features/workspace/knowledge): **Give your AI access to your documents and let it find what matters.** - [Models](https://docs.openwebui.com/features/workspace/models): **Wrap any model with custom instructions, tools, and knowledge to build specialized agents.** - [Prompts](https://docs.openwebui.com/features/workspace/prompts): **Reusable slash commands that turn complex instructions into one-click forms.** - [Skills](https://docs.openwebui.com/features/workspace/skills): **Teach your AI how to approach a task with plain-text instructions.** - [Getting Started with Open WebUI](https://docs.openwebui.com/getting-started): **From zero to your first AI conversation in under five minutes.** - [Advanced Topics](https://docs.openwebui.com/getting-started/advanced-topics): **Go beyond the defaults: scale, debug, and develop Open WebUI for production and contribution.** - [Developing Open WebUI](https://docs.openwebui.com/getting-started/advanced-topics/development): **Run Open WebUI from source for development and testing.** - [Hardening Open WebUI](https://docs.openwebui.com/getting-started/advanced-topics/hardening): Open WebUI is a self-hosted application that gives authenticated users access to model inference, tool execution, code pipelines, and more. Like other self-hosted infrastructure (... - [Logging Open WebUI](https://docs.openwebui.com/getting-started/advanced-topics/logging): **Control what Open WebUI logs, where it goes, and how it's formatted, from quick debugging to production log pipelines.** - [Scaling Open WebUI](https://docs.openwebui.com/getting-started/advanced-topics/scaling): Open WebUI is designed to scale with your needs, from a single user to organization-wide rollouts across entire enterprises and institutions. The steps below walk you through how... - [Essentials for Open WebUI](https://docs.openwebui.com/getting-started/essentials): You have installed Open WebUI, connected a provider, and had your first conversation. This page covers the key things that turn a basic chat UI into a setup that works well day-to... - [Open WebUI as an App](https://docs.openwebui.com/getting-started/open-webui-as-app): Every Open WebUI instance is a **Progressive Web App (PWA)**. You can install it as a standalone app on your phone, tablet, or desktop, directly from the browser. No separate down... - [Quick Start](https://docs.openwebui.com/getting-started/quick-start): Get Open WebUI running on your machine. Pick your preferred method below. - [Connect a Provider](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider): **Connect Open WebUI to your model provider and start chatting in minutes.** - [Anthropic (Claude)](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-anthropic): Open WebUI supports **Anthropic's Claude models** natively through their OpenAI-compatible endpoint. Just plug in your API key and start chatting: no middleware, no pipes, no extr... - [Functions](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-functions): **Pipe Functions** are Python plugins that appear as selectable models in your chat sidebar. Behind the scenes, they can do anything Python can do: integrate a proprietary AI prov... - [Llama.cpp](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-llama-cpp): Open WebUI makes it simple and flexible to connect and manage a local Llama.cpp server to run efficient, quantized language models. Whether you’ve compiled Llama.cpp yourself or y... - [Ollama](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-ollama): Open WebUI makes it easy to connect and manage your **Ollama** instance. This guide will walk you through setting up the connection, managing models, and getting started. - [Open Responses](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-open-responses): Open WebUI has experimental support for **[Open Responses](https://www.openresponses.org/)**, an open specification for multi-provider, interoperable LLM interfaces. This guide wa... - [OpenAI](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-openai): Open WebUI makes it easy to connect to **OpenAI** and **Azure OpenAI**. This guide will walk you through adding your API key, setting the correct endpoint, and selecting models, s... - [OpenAI-Compatible](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-openai-compatible): Open WebUI connects to **any server or provider that implements the OpenAI-compatible API**. This guide covers how to set up connections for popular cloud providers, gateways, and... - [vLLM](https://docs.openwebui.com/getting-started/quick-start/connect-a-provider/starting-with-vllm): vLLM provides an **OpenAI-compatible API** (Chat Completions), making it easy to connect to Open WebUI. This guide will show you how to connect your vLLM server. - [Connect an Agent](https://docs.openwebui.com/getting-started/quick-start/connect-an-agent): **Use Open WebUI as the chat frontend for autonomous AI agents.** - [Open WebUI Computer](https://docs.openwebui.com/getting-started/quick-start/connect-an-agent/cptr): **Connect Open WebUI Computer to Open WebUI.** - [Hermes Agent](https://docs.openwebui.com/getting-started/quick-start/connect-an-agent/hermes-agent): **Use Open WebUI as the chat frontend for Nous Research's autonomous AI agent.** - [OpenClaw](https://docs.openwebui.com/getting-started/quick-start/connect-an-agent/openclaw): **Connect the OpenClaw autonomous agent framework to Open WebUI.** - [Understanding Settings](https://docs.openwebui.com/getting-started/quick-start/settings): **Open WebUI has two separate settings areas, not one.** - [Sharing Open WebUI](https://docs.openwebui.com/getting-started/sharing): **Deploy once, give your entire team access.** - [Updating Open WebUI](https://docs.openwebui.com/getting-started/updating): **Stay current without losing your data.** - [Open WebUI License](https://docs.openwebui.com/license): [**View the full license on GitHub →**](https://github.com/open-webui/open-webui/blob/main/LICENSE) - [Our Mission](https://docs.openwebui.com/mission): ![Open WebUI mission: bringing intelligence home through owned context, local control, and AI that goes everywhere](/images/banners/mission-light.svg)![Open WebUI mission: bringin... - [Reference](https://docs.openwebui.com/reference): **The technical details behind every knob, endpoint, and configuration option.** - [API Endpoints](https://docs.openwebui.com/reference/api-endpoints): This guide provides essential information on how to interact with the API endpoints effectively to achieve seamless integration and automation using our models. Please note that t... - [Backend-Controlled API Flow](https://docs.openwebui.com/reference/api-flow): --- - [Database Schema](https://docs.openwebui.com/reference/database-schema): > **warning** - [Environment Variable Configuration](https://docs.openwebui.com/reference/env-configuration): Open WebUI provides a large range of environment variables that allow you to customize and configure various aspects of the application. This page serves as a comprehensive refere... - [HTTPS & Reverse Proxies](https://docs.openwebui.com/reference/https): **Secure your Open WebUI deployment with TLS encryption, reverse proxies, or managed tunnels.** - [HTTPS using Caddy](https://docs.openwebui.com/reference/https/caddy): Ensuring secure communication between your users and the Open WebUI is paramount. HTTPS (HyperText Transfer Protocol Secure) encrypts the data transmitted, protecting it from eave... - [HTTPS using Cloudflare Tunnel](https://docs.openwebui.com/reference/https/cloudflare-tunnel): **Expose Open WebUI to the internet securely. No open ports, no certificates, no reverse proxy.** - [HAProxy Configuration for Open WebUI](https://docs.openwebui.com/reference/https/haproxy): HAProxy (High Availability Proxy) is specialized load-balancing and reverse proxy solution that is highly configurable and designed to handle large amounts of connections with a r... - [HTTPS using Nginx](https://docs.openwebui.com/reference/https/nginx): Ensuring secure communication between your users and the Open WebUI is paramount. HTTPS (HyperText Transfer Protocol Secure) encrypts the data transmitted, protecting it from eave... - [HTTPS using ngrok](https://docs.openwebui.com/reference/https/ngrok): **Instant public HTTPS for your local Open WebUI. Zero config, zero open ports.** - [HTTPS using Tailscale](https://docs.openwebui.com/reference/https/tailscale): **Access Open WebUI securely from anywhere on your private network. No ports, no certificates, no public exposure.** - [Monitoring](https://docs.openwebui.com/reference/monitoring): **Know when something breaks before your users do.** - [OpenTelemetry](https://docs.openwebui.com/reference/monitoring/otel): Open WebUI supports **distributed tracing and metrics** export via the OpenTelemetry (OTel) protocol (OTLP). This enables integration with modern observability stacks such as **Gr... - [Network Diagrams](https://docs.openwebui.com/reference/network-diagrams): Visual C4 diagrams for common deployment topologies showing how Open WebUI, Ollama, and Docker communicate. Use these to debug connectivity issues or plan your architecture. - [Server-Side Tool Calling over the API](https://docs.openwebui.com/reference/server-side-tool-calling): **Send a prompt to Open WebUI, have Open WebUI run the tools, and get the finished answer back.** - [Roadmap](https://docs.openwebui.com/roadmap): Open WebUI is building the AI interface that aims to be the only one you need for working with AI. Here's where we're going. - [Security](https://docs.openwebui.com/security): **How Open WebUI approaches security, and how to report vulnerabilities responsibly.** - [Known & Accepted Risks](https://docs.openwebui.com/security/accepted-risks): **Residual risks that Open WebUI has assessed, mitigated as far as is technically possible or operationally sensible, and then formally accepted.** - [Agentic Application Risks](https://docs.openwebui.com/security/accepted-risks/agentic-application-risks): --- - [Authentication Timing Side-Channel](https://docs.openwebui.com/security/accepted-risks/auth-timing): --- - [LLM Output Unpredictability](https://docs.openwebui.com/security/accepted-risks/llm-output-unpredictability): --- - [OAuth Token Exchange Client Trust](https://docs.openwebui.com/security/accepted-risks/oauth-token-exchange-client-trust): --- - [Chat Data Privacy & Encryption](https://docs.openwebui.com/security/chat-data-privacy-and-encryption): Open WebUI is self-hosted software. Your organization controls the server, database, storage, model connections, logs, backups, and network placement. - [Security Policy](https://docs.openwebui.com/security/security-policy): > **Ground Truth** - [Supply Chain and Security Scanners](https://docs.openwebui.com/security/supply-chain-security): Automated software-composition and supply-chain scanners (for example socket.dev) periodically flag the Open WebUI PyPI packages and container images with risk indicators. This pa... - [Rejected CVEs in Vulnerability Databases](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases): When a CVE identifier is withdrawn, the authoritative record at [cve.org](https://www.cve.org) moves to the **REJECTED** state and NVD mirrors it. Downstream vulnerability databas... - [Askar Labs](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/askar-labs): --- - [BaseFortify by Axxemble](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/basefortify): --- - [CVEdetails](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/cvedetails): --- - [INCIBE-CERT](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/incibe): > **note** - [Positive Technologies (dbugs)](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/positive-technologies): --- - [Rapid7](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/rapid7): > **note** - [SentinelOne](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/sentinelone): > **There is no working way to reach SentinelOne about this** - [Tenable](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/tenable): > **note** - [Vulmon](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/vulmon): --- - [Vulners](https://docs.openwebui.com/security/supply-chain-security/vulnerability-databases/vulners): > **note** - [Vendor Dispositions](https://docs.openwebui.com/security/vendor-dispositions): **Open WebUI's formal assessments of externally reported CVEs and security claims.** - [CVE-2024-12534](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-12534): > **The mechanism the report depends on does not exist** - [CVE-2024-12537](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-12537): --- - [CVE-2024-7033](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7033): --- - [CVE-2024-7034](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7034): --- - [CVE-2024-7036](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7036): --- - [CVE-2024-7037](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7037): > **The alleged remote code execution is in a different application** - [CVE-2024-7038](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7038): --- - [CVE-2024-7039](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7039): --- - [CVE-2024-7040](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7040): --- - [CVE-2024-7045](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7045): --- - [CVE-2024-7046](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7046): > **The endpoint's intended audience is the people the report calls attackers** - [CVE-2024-7053](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7053): > **Every step of the chain fails independently** - [CVE-2024-7959](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7959): --- - [CVE-2024-7990](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-7990): --- - [CVE-2024-8060](https://docs.openwebui.com/security/vendor-dispositions/cve-2024-8060): > **The reported traversal is structurally impossible** - [CVE-2025-15603](https://docs.openwebui.com/security/vendor-dispositions/cve-2025-15603): --- - [CVE-2025-29446](https://docs.openwebui.com/security/vendor-dispositions/cve-2025-29446): --- - [CVE-2025-63391](https://docs.openwebui.com/security/vendor-dispositions/cve-2025-63391): > **Resolved: this CVE is now rejected** - [CVE-2026-0765](https://docs.openwebui.com/security/vendor-dispositions/cve-2026-0765): --- - [CVE-2026-0766](https://docs.openwebui.com/security/vendor-dispositions/cve-2026-0766): --- - [CVE-2026-0767](https://docs.openwebui.com/security/vendor-dispositions/cve-2026-0767): > **This describes the HTTP protocol, not Open WebUI** - [Sponsorships](https://docs.openwebui.com/sponsorships): ![Open WebUI Sponsorships: sponsors support the project while community-first policies protect users](/images/banners/sponsorships-light.svg)![Open WebUI Sponsorships: sponsors su... - [Our Team](https://docs.openwebui.com/team): > **tip** - [Troubleshooting](https://docs.openwebui.com/troubleshooting): Use this page to find the right guide for your issue. If you're unsure where to start, match your symptom in the table below. - [Audio Troubleshooting Guide](https://docs.openwebui.com/troubleshooting/audio): This page covers common issues with Speech-to-Text (STT) and Text-to-Speech (TTS) functionality in Open WebUI, along with their solutions. - [Connection Errors](https://docs.openwebui.com/troubleshooting/connection-error): This page covers common connection issues, their causes, and how to resolve them. - ["The prompt is too long"/ Model Context Length Exceeded](https://docs.openwebui.com/troubleshooting/context-window): Errors like: - [Custom CA Store](https://docs.openwebui.com/troubleshooting/custom-ca): > **warning** - [Image Generation](https://docs.openwebui.com/troubleshooting/image-generation): - **Image Not Generating** (asking for an image produces no image, or an error appears in the chat): - [Database Migration](https://docs.openwebui.com/troubleshooting/manual-database-migration): Open WebUI automatically runs database migrations on startup. **Manual migration is rarely needed** and should only be performed in specific failure scenarios or maintenance situa... - [Multi-Replica, High Availability & Concurrency Troubleshooting](https://docs.openwebui.com/troubleshooting/multi-replica): This guide addresses common issues encountered when deploying Open WebUI in **multi-replica** environments (e.g., Kubernetes, Docker Swarm) or when using **multiple workers** (`UV... - [Resetting Your Admin Password](https://docs.openwebui.com/troubleshooting/password-reset): Step-by-step guides for resetting your admin password in Docker and local installations. - [Optimization, Performance & RAM Usage](https://docs.openwebui.com/troubleshooting/performance): This guide provides a comprehensive overview of strategies to optimize Open WebUI. Your ideal configuration depends heavily on your specific deployment goals. Consider which of th... - [RAG](https://docs.openwebui.com/troubleshooting/rag): Retrieval-Augmented Generation (RAG) enables language models to reason over external content (documents, knowledge bases, and more) by retrieving relevant info and feeding it into... - [SSO & OAuth](https://docs.openwebui.com/troubleshooting/sso): OAuth and Single Sign-On (SSO) provide secure authentication for Open WebUI. When login problems occur, one of these common issues is usually the cause. - [Startup & Docker Failures](https://docs.openwebui.com/troubleshooting/startup): Open WebUI not coming up at all? Start here. For failures specifically about Alembic migrations (`no such table`, `Can't locate revision`), see [Database Migration](/troubleshooti... - [Web Search](https://docs.openwebui.com/troubleshooting/web-search): Web Search in Open WebUI allows language models to access real-time information from the internet. When things don't work as expected, this guide will help you diagnose and fix co... - [Tutorials](https://docs.openwebui.com/tutorials): **Step-by-step guides for real-world scenarios, contributed by the Open WebUI community.** - [Authentication & SSO Tutorials](https://docs.openwebui.com/tutorials/auth-sso): **Connect Open WebUI to your identity provider for single sign-on, LDAP, and group synchronization.** - [Azure AD LDAP](https://docs.openwebui.com/tutorials/auth-sso/azure-ad-ds-ldap): > **warning** - [Dual OAuth Configuration (Microsoft & Google)](https://docs.openwebui.com/tutorials/auth-sso/dual-oauth-configuration): > **Unofficial Workaround** - [Microsoft Entra ID Group Name Sync](https://docs.openwebui.com/tutorials/auth-sso/entra-group-name-sync): > **warning** - [Okta OIDC SSO Integration](https://docs.openwebui.com/tutorials/auth-sso/okta-oidc-sso): > **warning** - [Tailscale Integration](https://docs.openwebui.com/tutorials/auth-sso/tailscale): **Private, encrypted access to Open WebUI from any device. No ports to open, no certificates to manage.** - [Community Guides](https://docs.openwebui.com/tutorials/community): > **Community Content** - [Open WebUI on Unraid (Beginner-Safe)](https://docs.openwebui.com/tutorials/community/unraid): > **warning** - [Contributing to Documentation](https://docs.openwebui.com/tutorials/contributing-tutorial): > **warning** - [Integration Tutorials](https://docs.openwebui.com/tutorials/integrations): **Connect Open WebUI to LLM providers, developer tools, monitoring platforms, and external services.** - [Browser Search Engine Integration](https://docs.openwebui.com/tutorials/integrations/dev-tools/browser-search-engine): > **warning** - [Integrating Continue.dev VS Code Extension with Open WebUI](https://docs.openwebui.com/tutorials/integrations/dev-tools/continue-dev): > **warning** - [Firefox Sidebar](https://docs.openwebui.com/tutorials/integrations/dev-tools/firefox-sidebar): > **warning** - [Use your Open WebUI models with Iterm2](https://docs.openwebui.com/tutorials/integrations/dev-tools/iterm2): > **warning** - [Jupyter Notebook Integration](https://docs.openwebui.com/tutorials/integrations/dev-tools/jupyter): > [!WARNING] This documentation was created based on the current version (0.5.16) and is constantly being updated. - [LibreTranslate](https://docs.openwebui.com/tutorials/integrations/libre-translate): > **warning** - [Azure OpenAI with EntraID](https://docs.openwebui.com/tutorials/integrations/llm-providers/azure-openai): > **warning** - [Azure CLI Authentication](https://docs.openwebui.com/tutorials/integrations/llm-providers/azure-openai/azure-cli-auth): > **warning** - [Workload Identity Authentication](https://docs.openwebui.com/tutorials/integrations/llm-providers/azure-openai/workload-identity-auth): > **warning** - [DeepSeek R1 Dynamic](https://docs.openwebui.com/tutorials/integrations/llm-providers/deepseekr1-dynamic): A huge shoutout to **UnslothAI** for their incredible efforts! Thanks to their hard work, we can now run the **full DeepSeek-R1** 671B parameter model in its dynamic 1.58-bit quan... - [Intel GPU (IPEX-LLM)](https://docs.openwebui.com/tutorials/integrations/llm-providers/ipex_llm): > **warning** - [Notion (MCP)](https://docs.openwebui.com/tutorials/integrations/mcp-notion): > **Community Contribution** - [Helicone Integration with Open WebUI](https://docs.openwebui.com/tutorials/integrations/monitoring/helicone): > **warning** - [Langfuse](https://docs.openwebui.com/tutorials/integrations/monitoring/langfuse): > **warning** - [OneDrive & SharePoint](https://docs.openwebui.com/tutorials/integrations/onedrive-sharepoint): > **info** - [Redis Websocket Support](https://docs.openwebui.com/tutorials/integrations/redis): > **warning** - [Using Valkey](https://docs.openwebui.com/tutorials/integrations/valkey): > **warning** - [Maintenance Tutorials](https://docs.openwebui.com/tutorials/maintenance): **Keep your Open WebUI deployment healthy: backups, storage, offline mode, and database management.** - [Backing Up Your Instance](https://docs.openwebui.com/tutorials/maintenance/backups): > **warning** - [Exporting & Importing DB](https://docs.openwebui.com/tutorials/maintenance/database): > **warning** - [Running Open WebUI in offline mode](https://docs.openwebui.com/tutorials/maintenance/offline-mode): > **warning** - [Switching to S3 Storage](https://docs.openwebui.com/tutorials/maintenance/s3-storage): > **warning**