From 20ebb874fda66c82aeccf74d858bdf7b21f4d6b2 Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Wed, 15 Jan 2025 12:53:42 -0800 Subject: [PATCH] Update intro.mdx --- docs/intro.mdx | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/docs/intro.mdx b/docs/intro.mdx index a83a3c8..3868f27 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -95,6 +95,40 @@ docker run -d --name watchtower --restart unless-stopped -v /var/run/docker.sock ## Manual Installation +There are two main ways to install and run Open WebUI: using the `uv` runtime manager or Python's `pip`. While both methods are effective, **we strongly recommend using `uv`** as it simplifies environment management and minimizes potential conflicts. + +### Installation with `uv` (Recommended) + +The `uv` runtime manager ensures seamless Python environment management for applications like Open WebUI. Follow these steps to get started: + +#### 1. Install `uv` + +Pick the appropriate installation command for your operating system: + +- **macOS/Linux**: + ```bash + curl -LsSf https://astral.sh/uv/install.sh | sh + ``` + +- **Windows**: + ```powershell + powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" + ``` + +#### 2. Run 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: + +- **macOS/Linux**: + ```bash + DATA_DIR=~/.open-webui uvx --python 3.11 open-webui serve + ``` + +- **Windows**: + ```powershell + $env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui 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.