From 4bdb82906431c280ac8eab8abebef1cb5185594d Mon Sep 17 00:00:00 2001 From: Timothy Jaeryang Baek Date: Wed, 15 Jan 2025 12:56:36 -0800 Subject: [PATCH] refac --- docs/getting-started/quick-start/index.mdx | 7 +++-- .../quick-start/tab-python/Uv.md | 31 +++++++++++++++++++ .../quick-start/tab-python/Uvx.md | 0 docs/intro.mdx | 6 ++-- 4 files changed, 39 insertions(+), 5 deletions(-) create mode 100644 docs/getting-started/quick-start/tab-python/Uv.md delete mode 100644 docs/getting-started/quick-start/tab-python/Uvx.md diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx index a453a08..8143c40 100644 --- a/docs/getting-started/quick-start/index.mdx +++ b/docs/getting-started/quick-start/index.mdx @@ -15,6 +15,7 @@ import DockerUpdating from './tab-docker/DockerUpdating.md'; import Helm from './tab-kubernetes/Helm.md'; import Kustomize from './tab-kubernetes/Kustomize.md'; import Venv from './tab-python/Venv.md'; +import Uv from './tab-python/Uv.md'; import Conda from './tab-python/Conda.md'; import PythonUpdating from './tab-python/PythonUpdating.md'; @@ -68,12 +69,12 @@ Choose your preferred installation method below: - {/* +
- +
-
*/} +
diff --git a/docs/getting-started/quick-start/tab-python/Uv.md b/docs/getting-started/quick-start/tab-python/Uv.md new file mode 100644 index 0000000..36ac928 --- /dev/null +++ b/docs/getting-started/quick-start/tab-python/Uv.md @@ -0,0 +1,31 @@ +### Installation with `uv` + +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@latest serve + ``` + +- **Windows**: + ```powershell + $env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui@latest serve + ``` diff --git a/docs/getting-started/quick-start/tab-python/Uvx.md b/docs/getting-started/quick-start/tab-python/Uvx.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/intro.mdx b/docs/intro.mdx index 3868f27..72f3b0b 100644 --- a/docs/intro.mdx +++ b/docs/intro.mdx @@ -121,14 +121,16 @@ Once `uv` is installed, running Open WebUI is a breeze. Use the command below, e - **macOS/Linux**: ```bash - DATA_DIR=~/.open-webui uvx --python 3.11 open-webui serve + DATA_DIR=~/.open-webui uvx --python 3.11 open-webui@latest serve ``` - **Windows**: ```powershell - $env:DATA_DIR="C:\open-webui\data"; uvx --python 3.11 open-webui serve + $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.