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

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

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

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

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

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

copy .env.example .env

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

cp -RPp .env.example .env

Install the necessary dependencies using npm and build the project:

npm install
npm run build

Change the directory to backend:

cd ./backend

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

# 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

Windows:

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

start_windows.bat

If the port is in use, you can change it using:

set PORT=8888
start_windows.bat

Linux/macOS:

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

bash start.sh