From 7e86f246eeac431e1d523ab6a149e5dd04e8717d Mon Sep 17 00:00:00 2001 From: jiangying Date: Tue, 16 Jul 2024 23:34:29 +0800 Subject: [PATCH 1/4] Update index.mdx guide, use venv --- docs/getting-started/index.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index a4e479c..9fb7d7f 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -222,6 +222,8 @@ npm run build # Serving Frontend with the Backend cd ./backend +python -m venv +./venv/Scripts/activate pip install -r requirements.txt -U bash start.sh ``` From 6412372bf476ea031c521b5214fd92119b82f00a Mon Sep 17 00:00:00 2001 From: jiangying Date: Wed, 17 Jul 2024 11:19:11 +0800 Subject: [PATCH 2/4] Update index.mdx --- docs/getting-started/index.mdx | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 9fb7d7f..07ee7be 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -222,8 +222,12 @@ npm run build # Serving Frontend with the Backend cd ./backend -python -m venv -./venv/Scripts/activate + +# Optional, you can enable venv with to avoid pollute system packages +# python -m venv +# ./venv/Scripts/activate + +# Install dependencies pip install -r requirements.txt -U bash start.sh ``` From 1ee2fa930feef165e57e49774d5d2617704b33e0 Mon Sep 17 00:00:00 2001 From: jiangying Date: Wed, 17 Jul 2024 11:20:36 +0800 Subject: [PATCH 3/4] Update index.mdx --- docs/getting-started/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index 07ee7be..4d287aa 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -223,7 +223,7 @@ npm run build # Serving Frontend with the Backend cd ./backend -# Optional, you can enable venv with to avoid pollute system packages +# Optional, you can enable venv with to avoid collision with the system wide packages # python -m venv # ./venv/Scripts/activate From dab6d1c0610ed87fe8734c6e94ebe405b6ea6c5a Mon Sep 17 00:00:00 2001 From: jiangying Date: Fri, 19 Jul 2024 11:40:28 +0800 Subject: [PATCH 4/4] save --- docs/getting-started/index.mdx | 35 ++++++++++++++++++++++++++++++++-- 1 file changed, 33 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/index.mdx b/docs/getting-started/index.mdx index a4e479c..11ce05b 100644 --- a/docs/getting-started/index.mdx +++ b/docs/getting-started/index.mdx @@ -209,6 +209,7 @@ Open WebUI consists of two primary components: the frontend and the backend (whi Run the following commands to install: +For Linux/macOS: ```sh git clone https://github.com/open-webui/open-webui.git cd open-webui/ @@ -217,15 +218,45 @@ cd open-webui/ cp -RPp .env.example .env # Building Frontend Using Node -npm i +npm install npm run build -# Serving Frontend with the Backend cd ./backend + +# Optional: To install using Conda as your development environment, follow these instructions: +# Create and activate a Conda environment +conda create --name open-webui-env python=3.11 +conda activate open-webui-env + +# Install dependencies pip install -r requirements.txt -U + +# Start the application bash start.sh ``` +For Windows: +```powershell +git clone https://github.com/open-webui/open-webui.git +cd open-webui + +copy .env.example .env + +npm install +npm run build + +cd .\backend + +# Optional: To install using Conda as your development environment, follow these instructions: +# Create and activate a Conda environment +conda create --name open-webui-env python=3.11 +conda activate open-webui-env + +pip install -r requirements.txt -U + +start.bat +``` + You should have Open WebUI up and running at http://localhost:8080/. Enjoy! 😄 ## Docker Compose