khanh.pndc/open-webui-docs
1
0
Fork 0
mirror of https://github.com/open-webui/docs.git synced 2025-12-12 07:29:49 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore: format

Browse Source
This commit is contained in:
silentoplayz
2025-10-05 23:29:50 -04:00
parent c4ada90210
commit 3e3da9e0a0
152 changed files with 2247 additions and 1677 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/intro.mdx
View File

@@ -10,7 +10,6 @@ import { SponsorList } from "@site/src/components/SponsorList";
# Open WebUI
**Open WebUI is an [extensible](https://docs.openwebui.com/features/plugin/), feature-rich, and user-friendly self-hosted AI platform designed to operate entirely offline.** It supports various LLM runners like **Ollama** and **OpenAI-compatible APIs**, with **built-in inference engine** for RAG, making it a **powerful AI deployment solution**.
Passionate about open-source AI? [Join our team →](https://careers.openwebui.com/)
@@ -24,7 +23,7 @@ Passionate about open-source AI? [Join our team →](https://careers.openwebui.c
![GitHub top language](https://img.shields.io/github/languages/top/open-webui/open-webui)
![GitHub last commit](https://img.shields.io/github/last-commit/open-webui/open-webui?color=red)
[![Discord](https://img.shields.io/badge/Discord-Open_WebUI-blue?logo=discord&logoColor=white)](https://discord.gg/5rJgQTnV4s)
[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/tjbck)
[![Image Description](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/tjbck)
@@ -33,9 +32,11 @@ Passionate about open-source AI? [Join our team →](https://careers.openwebui.c
![Open WebUI Demo](/images/demo.png)
:::tip
**Looking for an [Enterprise Plan](https://docs.openwebui.com/enterprise)?** — **[Speak with Our Sales Team Today!](mailto:sales@openwebui.com)**
Get **enhanced capabilities**, including **custom theming and branding**, **Service Level Agreement (SLA) support**, **Long-Term Support (LTS) versions**, and **more!**
:::
<TopBanners />
@@ -91,7 +92,9 @@ After installation, you can access Open WebUI at [http://localhost:3000](http://
### Using the Dev Branch 🌙
:::warning
The `:dev` branch contains the latest unstable features and changes. Use it at your own risk as it may have bugs or incomplete features.
:::
If you want to try out the latest bleeding-edge features and are okay with occasional instability, you can use the `:dev` tag like this:
@@ -143,12 +146,12 @@ The `uv` runtime manager ensures seamless Python environment management for appl
Pick the appropriate installation command for your operating system:
- **macOS/Linux**:
- **macOS/Linux**:
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```
- **Windows**:
- **Windows**:
```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
@@ -157,17 +160,18 @@ Pick the appropriate installation command for your operating system:
Once `uv` is installed, running Open WebUI is a breeze. Use the command below, ensuring to set the `DATA_DIR` environment variable to avoid data loss. Example paths are provided for each platform:
- **macOS/Linux**:
- **macOS/Linux**:
```bash
DATA_DIR=~/.open-webui uvx --python 3.11 open-webui@latest serve
```
- **Windows**:
- **Windows**:
```powershell
$env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui@latest serve
```
:::note
:::note
**For PostgreSQL Support:**
The default installation now uses a slimmed-down package. If you need **PostgreSQL support**, install with all optional dependencies:
@@ -175,31 +179,32 @@ The default installation now uses a slimmed-down package. If you need **PostgreS
```bash
pip install open-webui[all]
```
:::
### Installation with `pip`
For users installing Open WebUI with Python's package manager `pip`, **it is strongly recommended to use Python runtime managers like `uv` or `conda`**. These tools help manage Python environments effectively and avoid conflicts.
For users installing Open WebUI with Python's package manager `pip`, **it is strongly recommended to use Python runtime managers like `uv` or `conda`**. These tools help manage Python environments effectively and avoid conflicts.
Python 3.11 is the development environment. Python 3.12 seems to work but has not been thoroughly tested. Python 3.13 is entirely untested and some dependencies do not work with Python 3.13 yet—**use at your own risk**.
1. **Install Open WebUI**:
1. **Install Open WebUI**:
Open your terminal and run the following command:
Open your terminal and run the following command:
```bash
pip install open-webui
```
2. **Start Open WebUI**:
2. **Start Open WebUI**:
Once installed, start the server using:
Once installed, start the server using:
```bash
open-webui serve
```
### Updating Open WebUI
To update to the latest version, simply run:
To update to the latest version, simply run:
```bash
pip install --upgrade open-webui
@@ -215,16 +220,14 @@ Continue with the full [getting started guide](/getting-started).
### Desktop App
We also have an **experimental** desktop app, which is actively a **work in progress (WIP)**. While it offers a convenient way to run Open WebUI natively on your system without Docker or manual setup, it is **not yet stable**.
We also have an **experimental** desktop app, which is actively a **work in progress (WIP)**. While it offers a convenient way to run Open WebUI natively on your system without Docker or manual setup, it is **not yet stable**.
👉 For stability and production use, we strongly recommend installing via **Docker** or **Python (`uv` or `pip`)**.
## Sponsors 🙌
<SponsorList />
We are incredibly grateful for the generous support of our sponsors. Their contributions help us to maintain and improve our project, ensuring we can continue to deliver quality work to our community. Thank you!
@@ -235,22 +238,28 @@ We are deeply grateful for the generous grant support provided by:
<div className="grid gap-4 items-start grid-cols-1 md:grid-cols-2">
<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">
<img src="/sponsors/grants/a16z.png" alt="A16z" width={"300px"} style={{verticalAlign:'middle',marginRight:'12px'}} />
<div className="max-w-full h-auto">
![A16z](/sponsors/grants/a16z.png)
</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">
<img src="/sponsors/grants/mozilla.png" alt="Mozilla" width={"300px"} style={{verticalAlign:'middle',marginRight:'12px'}} />
<div className="max-w-full h-auto">
![Mozilla](/sponsors/grants/mozilla.png)
</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">
<img src="/sponsors/grants/github.png" alt="GitHub" width={"300px"} style={{verticalAlign:'middle',marginRight:'16px'}} />
<div className="max-w-full h-auto">
![GitHub](/sponsors/grants/github.png)
</div>
<span style={{verticalAlign:'middle', fontWeight:600, fontSize:'1.05em'}}>GitHub Accelerator 2024</span>
</a>
</div>