mirror of
https://github.com/open-webui/docs.git
synced 2026-11-04 08:08:30 +00:00
207 lines
9.0 KiB
Plaintext
207 lines
9.0 KiB
Plaintext
---
|
|
sidebar_position: 0
|
|
slug: /
|
|
title: Home
|
|
hide_title: true
|
|
---
|
|
|
|
|
|
import { SponsorList } from "@site/src/components/SponsorList";
|
|
import ThemedImage from '@theme/ThemedImage';
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import useBaseUrl from '@docusaurus/useBaseUrl';
|
|
|
|
# Open WebUI
|
|
|
|
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.openwebui.com/features/)**, user-friendly, and built to run **[entirely offline](https://openwebui.com/sovereign-ai)**. With support for **Ollama** and **OpenAI-compatible APIs**, it gives you a powerful, provider-agnostic interface for both local and cloud-based models.
|
|
|
|
<ThemedImage
|
|
alt="Open WebUI: a self-hosted AI platform connecting local and cloud models with tools and knowledge"
|
|
sources={{
|
|
light: useBaseUrl('/images/banners/home-light.svg'),
|
|
dark: useBaseUrl('/images/banners/home-dark.svg'),
|
|
}}
|
|
style={{ width: '100%', margin: '0.25rem 0 1.75rem' }}
|
|
/>
|
|
|
|
|
|
|
|
[](https://discord.gg/5rJgQTnV4s)
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
<Tabs>
|
|
<TabItem value="docker" label="Docker" default>
|
|
|
|
```bash
|
|
docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data -e WEBUI_SECRET_KEY=your-secret-key --name open-webui --restart always ghcr.io/open-webui/open-webui:main
|
|
```
|
|
|
|
For GPU support, Docker Compose, and more → [Quick Start](/getting-started/quick-start) and [Docker images and tags](/getting-started/quick-start#image-variants)
|
|
|
|
:::tip Pick the right image
|
|
Use `:main` for built-in embeddings, document extraction and speech recognition. Choose `:slim` for a **lean, memory-efficient, scalable** deployment: **197 MB to download** (88% smaller) and **about 300 MiB of RAM at idle** in our [test](/getting-started/quick-start#slim-memory-usage). You get the same chat experience with **minimal overhead** and a **small footprint**, with external services handling embeddings, document extraction and voice. [Why choose slim?](/getting-started/quick-start#what-slim-leaves-out)
|
|
:::
|
|
|
|
Then open [http://localhost:3000](http://localhost:3000).
|
|
|
|
<video
|
|
autoPlay
|
|
muted
|
|
loop
|
|
playsInline
|
|
poster={useBaseUrl('/images/landing/hero.png')}
|
|
aria-label="Open WebUI running a live analysis: a local model reads a spreadsheet through Open Terminal, totals it with Python and draws an interactive revenue dashboard inline in the chat"
|
|
style={{ display: 'block', width: '100%', borderRadius: 12, margin: '0.75rem 0 0.5rem' }}
|
|
>
|
|
<source src={useBaseUrl('/images/landing/hero.mp4')} type="video/mp4" />
|
|
</video>
|
|
|
|
<p style={{ fontSize: '0.85rem', opacity: 0.7, margin: '0 0 1rem' }}>
|
|
Powered by <a href="/features/open-terminal">Open Terminal</a> and some of our <a href="/features/extensibility/community">amazing community built plugins</a>.
|
|
</p>
|
|
|
|
</TabItem>
|
|
<TabItem value="pip" label="pip">
|
|
|
|
```bash
|
|
pip install open-webui
|
|
open-webui serve
|
|
```
|
|
|
|
Then open [http://localhost:8080](http://localhost:8080).
|
|
|
|
</TabItem>
|
|
<TabItem value="uv" label="uv">
|
|
|
|
```bash
|
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
DATA_DIR=~/.open-webui uvx --python 3.12 open-webui@latest serve
|
|
```
|
|
|
|
Then open [http://localhost:8080](http://localhost:8080).
|
|
|
|
</TabItem>
|
|
<TabItem value="desktop" label="Desktop">
|
|
|
|
Download the desktop app from [**github.com/open-webui/desktop**](https://github.com/open-webui/desktop). It runs Open WebUI natively on your system without Docker or manual setup.
|
|
|
|
:::info
|
|
For production deployments, install via **Docker** or **Python**.
|
|
:::
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
:::tip Running? Read this next.
|
|
Installed Open WebUI but not sure where to start? The [**Essentials for Open WebUI**](/getting-started/essentials) guide covers what every new user needs to know: plugins, tool calling, task models, context management, RAG, web search and Open Terminal.
|
|
:::
|
|
|
|
---
|
|
|
|
## Getting Started
|
|
|
|
- [**Quick Start**](/getting-started/quick-start): Docker, Python, Kubernetes and desktop app install options
|
|
- [**Connect a Provider**](/getting-started/quick-start/connect-a-provider): Ollama, OpenAI, Anthropic, vLLM, and more
|
|
- [**Essentials for Open WebUI**](/getting-started/essentials): Start here after your first install. Plugins, tool calling, task models, context management, RAG, web search, Open Terminal.
|
|
- [**Connect an Agent**](/getting-started/quick-start/connect-an-agent): Open WebUI Computer, Hermes Agent, OpenClaw, and other autonomous AI agents
|
|
- [**Updating**](/getting-started/updating): Keep your instance current
|
|
- [**Development Branch**](/getting-started/quick-start#using-the-dev-branch): Help test the latest changes before stable release
|
|
- [**Advanced Topics**](/getting-started/advanced-topics): Scaling, logging, and advanced configuration
|
|
|
|
---
|
|
|
|
## Explore
|
|
|
|
- [**Features**](/features): Discover what Open WebUI can do
|
|
- [**Tutorials**](/tutorials): Step-by-step guides
|
|
- [**FAQ**](/faq): Common questions answered
|
|
- [**Troubleshooting**](/troubleshooting): Fix common issues
|
|
- [**Reference**](/reference): Environment variables and API details
|
|
|
|
---
|
|
|
|
## Agentic Execution with Open Terminal
|
|
|
|
[**Open Terminal**](/features/open-terminal) gives an agent a real terminal and filesystem, so it can carry out multi-step work instead of only describing it: analyze data, run scripts, fix its own errors, and hand you the files it produced, all inside the chat. A [file browser](/features/open-terminal/file-browser) beside the conversation shows everything it creates.
|
|
|
|
For teams, [**Terminals**](/features/open-terminal/terminals) is the enterprise layer on top, giving every user an isolated environment with resource limits and automatic lifecycle management.
|
|
|
|
---
|
|
|
|
## Also by Open WebUI
|
|
|
|
- [**open-terminal**](https://github.com/open-webui/open-terminal): Turn Open WebUI into a full agent harness with a real action runtime: sandboxed files, shell, code execution, previews, and artifacts.
|
|
- [**oikb**](https://github.com/open-webui/oikb): Keep your Open WebUI knowledge bases in sync. Watches local folders, GitHub repos, S3 buckets, Confluence, and 40+ other sources.
|
|
- [**mcpo**](https://github.com/open-webui/mcpo): MCP-to-OpenAPI proxy. Use any MCP tool server with Open WebUI (or any OpenAPI client) without custom glue code.
|
|
|
|
---
|
|
|
|
## Enterprise
|
|
|
|
Built for teams and organizations, Open WebUI combines full control over your data and infrastructure with a stateless architecture that [scales from a pilot to an organization-wide deployment](/getting-started/advanced-topics/scaling).
|
|
|
|
Need **custom branding**, **SLA support**, or **Long-Term Support (LTS)**?
|
|
→ [Learn about Enterprise plans](/enterprise)
|
|
|
|
---
|
|
|
|
## Get Involved
|
|
|
|
- [**Contributing**](/contributing): Help build Open WebUI
|
|
- [**Development Setup**](/getting-started/advanced-topics/development): Run the project locally from source
|
|
- [**Discord**](https://discord.gg/5rJgQTnV4s): Join the community
|
|
- [**GitHub**](https://github.com/open-webui/open-webui): Report issues, submit PRs
|
|
- [**Careers**](https://careers.openwebui.com/): Join our team
|
|
|
|
---
|
|
|
|
## Sponsors
|
|
|
|
<SponsorList />
|
|
|
|
---
|
|
|
|
## Acknowledgements
|
|
|
|
<div className="grid gap-4 items-start grid-cols-1 md:grid-cols-3">
|
|
|
|
<a href="https://a16z.com/advancing-open-source-ai-through-benchmarks-and-bold-experimentation/" title="A16z Open Source AI Grant 2025" target="_blank" rel="noopener" className="flex flex-col w-fit gap-2 items-center">
|
|
<div className="max-w-full h-auto">
|
|
|
|
</div>
|
|
<span style={{verticalAlign:'middle', fontWeight:600, fontSize:'1.05em'}}>A16z Open Source AI Grant 2025</span>
|
|
</a>
|
|
|
|
<a href="https://builders.mozilla.org/" title="Mozilla Builders 2024" target="_blank" rel="noopener" className="flex flex-col w-fit gap-2 items-center">
|
|
<div className="max-w-full h-auto">
|
|
|
|
</div>
|
|
<span style={{verticalAlign:'middle', fontWeight:600, fontSize:'1.05em'}}>Mozilla Builders 2024</span>
|
|
</a>
|
|
|
|
<a href="https://github.com/accelerator" title="GitHub Accelerator 2024" target="_blank" rel="noopener" className="flex flex-col w-fit gap-2 items-center">
|
|
<div className="max-w-full h-auto">
|
|
|
|
</div>
|
|
<span style={{verticalAlign:'middle', fontWeight:600, fontSize:'1.05em'}}>GitHub Accelerator 2024</span>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## For LLMs and coding agents
|
|
|
|
Machine-readable entry points to this documentation:
|
|
|
|
- [llms.txt](https://docs.openwebui.com/llms.txt): curated index of every docs page with short descriptions.
|
|
- [llms-full.txt](https://docs.openwebui.com/llms-full.txt): every docs page concatenated into a single Markdown file.
|
|
- [agents.txt](https://docs.openwebui.com/agents.txt): concise instructions for agents using these docs.
|
|
- [api/search?q=YOUR_QUERY](https://docs.openwebui.com/api/search?q=YOUR_QUERY): deterministic docs search.
|
|
|
|
All files are generated fresh on every deploy.
|