mirror of
https://github.com/open-webui/docs.git
synced 2026-01-02 17:59:41 +07:00
e2212601d9
Removed "Version" syntax from top of compose file as it is obsolete as of Docker Compose spec v2. See: https://github.com/compose-spec/compose-spec/blob/main/00-overview.md
54 lines
1.6 KiB
Markdown
54 lines
1.6 KiB
Markdown
# 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](docs/tutorials/docker-install.md).
|
|
|
|
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:
|
|
|
|
```yaml
|
|
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:
|
|
|
|
```bash
|
|
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, you change the image from `ghcr.io/open-webui/open-webui:main` to `ghcr.io/open-webui/open-webui:cuda` and add the following to your service definition in the `docker-compose.yml` file:
|
|
|
|
```yaml
|
|
deploy:
|
|
resources:
|
|
reservations:
|
|
devices:
|
|
- driver: nvidia
|
|
count: all
|
|
capabilities: [gpu]
|
|
```
|
|
|
|
This setup ensures that your application can leverage GPU resources when available.
|