This commit is contained in:
Timothy J. Baek 2024-11-06 22:45:21 -08:00
parent 2edd12ed96
commit 584777f29a
3 changed files with 33 additions and 68 deletions

View File

@ -21,7 +21,7 @@ import CondaWindows from './tab-python/CondaWindows.md';
<TopBanners />
## How to Install ⏱️
# How to Install ⏱️
:::info **Important Note on User Roles and Privacy:**
@ -33,15 +33,15 @@ import CondaWindows from './tab-python/CondaWindows.md';
Choose your preferred installation method below:
- **Docker:** **Recommended for most users** due to ease of setup and flexibility.
- **Python:** Suitable for low-resource environments or those wanting a manual setup.
- **Kubernetes:** Ideal for enterprise deployments that require scaling and orchestration.
- **Docker:** **Officially supported and recommended for most users**
- **Python:** Suitable for low-resource environments or those wanting a manual setup
- **Kubernetes:** Ideal for enterprise deployments that require scaling and orchestration
<Tabs>
<TabItem value="docker" label="Docker">
<Tabs>
<TabItem value="manual-docker" label="Docker">
<TabItem value="docker" label="Docker">
<div className='mt-5'>
<ManualDocker />
<DataStorage />
@ -49,11 +49,9 @@ Choose your preferred installation method below:
</div>
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="compose" label="Docker Compose">
<div className='mt-5'>
<DockerCompose />
<DataStorage />
<DockerUpdating />
</div>
</TabItem>
@ -156,8 +154,3 @@ 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](../../troubleshooting/index.mdx).
Happy exploring! 🎉

View File

@ -1,42 +1,26 @@
## Updating
To update your local Docker installation to the latest version, you can either use **Watchtower** or manually update the container.
# Docker Compose Setup
Using Docker Compose simplifies the management of multi-container Docker applications.
## Example `docker-compose.yml`
```yaml
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:
### Option 1: Using Watchtower
With [Watchtower](https://containrrr.dev/watchtower/), you can automate the update process:
```bash
docker compose up -d
docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once open-webui
```
_(Replace `open-webui` with your container's name if it's different.)_
### Option 2: Manual Update
1. Stop and remove the current container:
```bash
docker rm -f open-webui
```
2. Pull the latest version:
```bash
docker pull ghcr.io/open-webui/open-webui:main
```
3. Start the container again:
```bash
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main
```
---
**Note:** For Nvidia GPU support, add the following to your service definition:
```yaml
deploy:
resources:
reservations:
devices:
- driver: nvidia
count: all
capabilities: [gpu]
```
Both methods will get your Docker instance updated and running with the latest build.

View File

@ -1,24 +1,12 @@
# Manual Docker Setup
If you prefer to set up Docker manually, follow these steps.
## Step 1: Pull the Open WebUI Image
```bash
docker pull ghcr.io/open-webui/open-webui:main
```
## Step 2: Run the Container
# Docker Setup
```bash
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main
```
**Note:** For Nvidia GPU support, add `--gpus all`. You can also use the `:cuda` tag for CUDA or `:ollama` for the bundled Ollama variant.
**Note:** For Nvidia GPU support, add `--gpus all` to the `docker run` command.
For the latest bleeding-edge features, with potential bugs or occasional instability, use the `:dev` tag:
```bash
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:dev
```
## Access the WebUI
After the container is running, access Open WebUI at:
[http://localhost:3000](http://localhost:3000)
Access Open WebUI at: [http://localhost:3000](http://localhost:3000)