Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add uv tool install instructions #426

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

doc: add uv tool install instructions #426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f6e4914
Added `uv tool install` instructions.
jerieljan Mar 2, 2025
d9d5856
Readded the DATA_DIR portion for the uvx part of the doc.
jerieljan Mar 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions docs/intro.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ There are two main ways to install and run Open WebUI: using the `uv` runtime ma

The `uv` runtime manager ensures seamless Python environment management for applications like Open WebUI. Follow these steps to get started:

#### 1. Install `uv`
1. **Install `uv`**

Pick the appropriate installation command for your operating system:

Expand All @@ -126,9 +126,29 @@ Pick the appropriate installation command for your operating system:
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```

#### 2. Run Open WebUI
2. **Install Open WebUI**:

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:
Open your terminal and run the following command:
```bash
uv tool install --python 3.11 open-webui
```

3. **Start Open WebUI**:

Once installed, start the server using:
```bash
open-webui serve
```

To update to the latest version, simply run:

```bash
uv tool upgrade open-webui
```

If you only need to run open-webui temporarily and do not need a permanent installation, you can also opt to use `uvx` or `uv tool run`.

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**:
```bash
Expand All @@ -140,8 +160,6 @@ Once `uv` is installed, running Open WebUI is a breeze. Use the command below, e
$env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui@latest serve
```



### 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.
Expand Down