Skip to main content

⏱️ Quick Start

Sponsored by Open WebUI Pipelines
Open WebUI Pipelines
Pipelines: Versatile, UI-Agnostic OpenAI-Compatible Plugin Framework

How to Install ⏱️​

Important Note on User Roles and Privacy:
  • Admin Creation: The first account created on Open WebUI gains Administrator privileges, controlling user management and system settings.
  • User Registrations: Subsequent sign-ups start with Pending status, requiring Administrator approval for access.
  • Privacy and Data Security: All your data, including login details, is locally stored on your device. Open WebUI ensures strict confidentiality and no external requests for enhanced privacy and security.

Choose your preferred installation method below:

  • Docker: Recommended for most users due to ease of setup and flexibility.
  • Kubernetes: Ideal for enterprise deployments that require scaling and orchestration.
  • Python: Suitable for low-resource environments or those wanting a manual setup.

Docker Compose Setup

Using Docker Compose simplifies the management of multi-container Docker applications.

If you don't have Docker installed, check out our Docker installation tutorial.

Docker Compose requires an additional package, docker-compose-v2.

Warning: Older Docker Compose tutorials may reference version 1 syntax, which uses commands like docker-compose build. Ensure you use version 2 syntax, which uses commands like docker compose build (note the space instead of a hyphen).

Example docker-compose.yml​

Here is an example configuration file for setting up Open WebUI with Docker Compose:

version: '3'
services:
  openwebui:
    image: ghcr.io/open-webui/open-webui:main
    ports:
      - "3000:8080"
    volumes:
      - open-webui:/app/backend/data
volumes:
  open-webui:

Starting the Services​

To start your services, run the following command:

docker compose up -d

Helper Script​

A useful helper script called run-compose.sh is included with the codebase. This script assists in choosing which Docker Compose files to include in your deployment, streamlining the setup process.

Note: For Nvidia GPU support, add the following to your service definition in the docker-compose.yml file:

deploy:
  resources:
    reservations:
      devices:
        - driver: nvidia
          count: all
          capabilities: [gpu]

This setup ensures that your application can leverage GPU resources when available.

Data Storage and Bind Mounts​

This project uses Docker named volumes to persist data. If needed, replace the volume name with a host directory:

Example:

-v /path/to/folder:/app/backend/data

Ensure the host folder has the correct permissions.

Docker Compose Setup

Using Docker Compose simplifies the management of multi-container Docker applications.

Example docker-compose.yml​

version: '3'
services:
  openwebui:
    image: ghcr.io/open-webui/open-webui:main
    ports:
      - "3000:8080"
    volumes:
      - open-webui:/app/backend/data
volumes:
  open-webui:

Starting the Services​

To start your services, run:

docker compose up -d

Note: For Nvidia GPU support, add the following to your service definition:

deploy:
  resources:
    reservations:
      devices:
        - driver: nvidia
          count: all
          capabilities: [gpu]

Next Steps​

After installing, visit:

You are now ready to start Using OpenWebUI!

Join the Community​

Need help? Have questions? Join our community:

Stay updated with the latest features, troubleshooting tips, and announcements!

Conclusion​

Thank you for choosing Open WebUI! We are committed to providing a powerful, privacy-focused interface for your LLM needs. If you encounter any issues, refer to the Troubleshooting Guide.

Happy exploring! 🎉