From f6e49141f74d8d6525ae892c1d195a553c00ae82 Mon Sep 17 00:00:00 2001 From: Jeriel Jan del Prado Date: Sun, 2 Mar 2025 19:01:38 +0800 Subject: [PATCH] Added `uv tool install` instructions. --- docs/intro.mdx | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/docs/intro.mdx b/docs/intro.mdx index 9e2d7b1..eff0b62 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -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: @@ -126,13 +126,33 @@ 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 - DATA_DIR=~/.open-webui uvx --python 3.11 open-webui@latest serve + , uvx --python 3.11 open-webui@latest serve ``` - **Windows**: @@ -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.