====== Install open-webui from source ======

This is a step-by-step guide for installing and setting up the **open-webui** project.

==== Prerequisites ====

Before you begin, ensure you have the following installed on your system:

  * 🐰 Node.js >= 20.10
  * 🐍 Python >= 3.11

==== Cloning and Initial Setup ====

To begin, clone the repository and change into the directory:

<code>
git clone https://github.com/open-webui/open-webui.git
cd open-webui
</code>

==== Windows Setup ====

Copy the example environment file to a new .env file:

<code>
copy .env.example .env
</code>

==== Linux/macOS Setup ====

Copy the example environment file to a new .env file:

<code>
cp -RPp .env.example .env
</code>

==== Installing Dependencies and Building ====

Install the necessary dependencies using npm and build the project:

<code>
npm install
npm run build
</code>

Change the directory to backend:

<code>
cd ./backend
</code>

==== Optional Conda Setup ====

If you prefer to use Conda as your development environment, follow these steps to create and activate a Conda environment:

<code>
# Create a new Conda environment
conda create --name open-webui-env python=3.11

# Activate the Conda environment
conda activate open-webui-env

# Install dependencies
pip install -r requirements.txt -U
</code>

==== Running the Application ====

**Windows:**

To run the application, execute the start.bat file:

<code>
start_windows.bat
</code>

If the port is in use, you can change it using:
<code>
set PORT=8888
start_windows.bat
</code>

**Linux/macOS:**

To run the application, execute the start.sh script:

<code>
bash start.sh
</code>