mirror of
https://github.com/open-webui/docs
synced 2025-06-16 11:28:36 +00:00
refac
This commit is contained in:
Timothy Jaeryang Baek
parent
6b2523cf35
commit
7c221579ad
@ -15,12 +15,6 @@ Get up and running quickly with our [Quick Start Guide](./quick-start).
|
||||
|
||||
---
|
||||
|
||||
## 📚 Using OpenWebUI
|
||||
|
||||
Learn the basics and explore key concepts in our [Using OpenWebUI Guide](./using-openwebui).
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Advanced Topics
|
||||
|
||||
Take a deeper dive into configurations and development tips in our [Advanced Topics Guide](./advanced-topics).
|
||||
|
||||
@ -1,101 +1,35 @@
|
||||
## Why isn't my Open WebUI updating?
|
||||
## Updating
|
||||
|
||||
To update your local Docker installation of Open WebUI to the latest version available, you can either use **Watchtower** or manually update the container. Follow either of the steps provided below to be guided through updating your existing Open WebUI image.
|
||||
To update your local Docker installation to the latest version, you can either use **Watchtower** or manually update the container.
|
||||
|
||||
### Manual Update
|
||||
### Option 1: Using Watchtower
|
||||
|
||||
1. **Stop and remove the current container**:
|
||||
|
||||
This will stop the running container and remove it, but it won't delete the data stored in the Docker volume. (Replace `open-webui` with your container's name throughout the updating process if it's different for you.)
|
||||
|
||||
```bash
|
||||
docker rm -f open-webui
|
||||
```
|
||||
|
||||
2. **Pull the latest Docker image**:
|
||||
|
||||
This will update the Docker image, but it won't update the running container or its data.
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
3. **Remove any existing data in the Docker volume (NOT RECOMMENDED UNLESS ABSOLUTELY NECCESSARY!)**. Skip this step entirely if not needed and move on to the last step:
|
||||
|
||||
If you want to start with a clean slate, you can remove the existing data in the Docker volume. Be careful, as this will delete all your chat histories and other data.
|
||||
|
||||
The data is stored in a Docker volume named `open-webui`. You can remove it with the following command:
|
||||
|
||||
```bash
|
||||
docker volume rm open-webui
|
||||
```
|
||||
|
||||
4. **Start the container again with the updated image and existing volume attached**:
|
||||
|
||||
If you didn't remove the existing data, this will start the container with the updated image and the existing data. If you removed the existing data, this will start the container with the updated image and a new, empty volume. **For Nvidia GPU support, add `--gpus all` to the docker run command**
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
## Automatically Updating Open WebUI with Watchtower
|
||||
|
||||
You can use [Watchtower](https://containrrr.dev/watchtower/) to automate the update process for Open WebUI. Here are three options:
|
||||
|
||||
### Option 1: One-time Update
|
||||
|
||||
You can run Watchtower as a one-time update to stop the current container, pull the latest image, and start a new container with the updated image and existing volume attached (**For Nvidia GPU support, add `--gpus all` to the docker run command**):
|
||||
With [Watchtower](https://containrrr.dev/watchtower/), you can automate the update process:
|
||||
|
||||
```bash
|
||||
docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once open-webui
|
||||
```
|
||||
|
||||
### Option 2: Running Watchtower as a Separate Container
|
||||
_(Replace `open-webui` with your container's name if it's different.)_
|
||||
|
||||
You can run Watchtower as a separate container that watches and updates your Open WebUI container:
|
||||
### Option 2: Manual Update
|
||||
|
||||
```bash
|
||||
docker run -d --name watchtower \
|
||||
--volume /var/run/docker.sock:/var/run/docker.sock \
|
||||
containrrr/watchtower -i 300 open-webui
|
||||
```
|
||||
1. Stop and remove the current container:
|
||||
|
||||
This will start Watchtower in detached mode, watching your Open WebUI container for updates every 5 minutes.
|
||||
```bash
|
||||
docker rm -f open-webui
|
||||
```
|
||||
|
||||
### Option 3: Integrating Watchtower with a `docker-compose.yml` File
|
||||
2. Pull the latest version:
|
||||
|
||||
You can also integrate Watchtower with your `docker-compose.yml` file to automate updates for Open WebUI (**For Nvidia GPU support, add `--gpus all` to the docker run command**):
|
||||
```bash
|
||||
docker pull ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
services:
|
||||
open-webui:
|
||||
image: ghcr.io/open-webui/open-webui:main
|
||||
ports:
|
||||
- "3000:8080"
|
||||
volumes:
|
||||
- open-webui:/app/backend/data
|
||||
3. Start the container again:
|
||||
|
||||
watchtower:
|
||||
image: containrrr/watchtower
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
command: --interval 300 open-webui
|
||||
depends_on:
|
||||
- open-webui
|
||||
```bash
|
||||
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
volumes:
|
||||
open-webui:
|
||||
```
|
||||
|
||||
In this example, Watchtower is integrated with the `docker-compose.yml` file and watches the Open WebUI container for updates every 5 minutes.
|
||||
|
||||
## Persistent Data in Docker Volumes
|
||||
|
||||
The data is stored in a Docker volume named `open-webui`. The path to the volume is not directly accessible, but you can inspect the volume with the following command:
|
||||
|
||||
```bash
|
||||
docker volume inspect open-webui
|
||||
```
|
||||
|
||||
This will show you the details of the volume, including the mountpoint, which is usually located in `/var/lib/docker/volumes/open-webui/_data`.
|
||||
Both methods will get your Docker instance updated and running with the latest build.
|
||||
|
||||
111
docs/getting-started/updating.mdx
Normal file
111
docs/getting-started/updating.mdx
Normal file
@ -0,0 +1,111 @@
|
||||
---
|
||||
sidebar_position: 300
|
||||
title: "🔄 Updating Open WebUI"
|
||||
---
|
||||
|
||||
|
||||
|
||||
## Why isn't my Open WebUI updating?
|
||||
|
||||
To update your local Docker installation of Open WebUI to the latest version available, you can either use **Watchtower** or manually update the container. Follow either of the steps provided below to be guided through updating your existing Open WebUI image.
|
||||
|
||||
### Manual Update
|
||||
|
||||
1. **Stop and remove the current container**:
|
||||
|
||||
This will stop the running container and remove it, but it won't delete the data stored in the Docker volume. (Replace `open-webui` with your container's name throughout the updating process if it's different for you.)
|
||||
|
||||
```bash
|
||||
docker rm -f open-webui
|
||||
```
|
||||
|
||||
2. **Pull the latest Docker image**:
|
||||
|
||||
This will update the Docker image, but it won't update the running container or its data.
|
||||
|
||||
```bash
|
||||
docker pull ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
|
||||
:::info
|
||||
**Remove any existing data in the Docker volume (NOT RECOMMENDED UNLESS ABSOLUTELY NECCESSARY!)**. Skip this step entirely if not needed and move on to the last step:
|
||||
|
||||
If you want to start with a clean slate, you can remove the existing data in the Docker volume. Be careful, as this will delete all your chat histories and other data.
|
||||
|
||||
The data is stored in a Docker volume named `open-webui`. You can remove it with the following command:
|
||||
|
||||
```bash
|
||||
docker volume rm open-webui
|
||||
```
|
||||
:::
|
||||
|
||||
3. **Start the container again with the updated image and existing volume attached**:
|
||||
|
||||
If you didn't remove the existing data, this will start the container with the updated image and the existing data. If you removed the existing data, this will start the container with the updated image and a new, empty volume. **For Nvidia GPU support, add `--gpus all` to the docker run command**
|
||||
|
||||
```bash
|
||||
docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui ghcr.io/open-webui/open-webui:main
|
||||
```
|
||||
|
||||
## Automatically Updating Open WebUI with Watchtower
|
||||
|
||||
You can use [Watchtower](https://containrrr.dev/watchtower/) to automate the update process for Open WebUI. Here are three options:
|
||||
|
||||
### Option 1: One-time Update
|
||||
|
||||
You can run Watchtower as a one-time update to stop the current container, pull the latest image, and start a new container with the updated image and existing volume attached (**For Nvidia GPU support, add `--gpus all` to the docker run command**):
|
||||
|
||||
```bash
|
||||
docker run --rm --volume /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower --run-once open-webui
|
||||
```
|
||||
|
||||
### Option 2: Running Watchtower as a Separate Container
|
||||
|
||||
You can run Watchtower as a separate container that watches and updates your Open WebUI container:
|
||||
|
||||
```bash
|
||||
docker run -d --name watchtower \
|
||||
--volume /var/run/docker.sock:/var/run/docker.sock \
|
||||
containrrr/watchtower -i 300 open-webui
|
||||
```
|
||||
|
||||
This will start Watchtower in detached mode, watching your Open WebUI container for updates every 5 minutes.
|
||||
|
||||
### Option 3: Integrating Watchtower with a `docker-compose.yml` File
|
||||
|
||||
You can also integrate Watchtower with your `docker-compose.yml` file to automate updates for Open WebUI (**For Nvidia GPU support, add `--gpus all` to the docker run command**):
|
||||
|
||||
```yml
|
||||
version: '3'
|
||||
services:
|
||||
open-webui:
|
||||
image: ghcr.io/open-webui/open-webui:main
|
||||
ports:
|
||||
- "3000:8080"
|
||||
volumes:
|
||||
- open-webui:/app/backend/data
|
||||
|
||||
watchtower:
|
||||
image: containrrr/watchtower
|
||||
volumes:
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
command: --interval 300 open-webui
|
||||
depends_on:
|
||||
- open-webui
|
||||
|
||||
volumes:
|
||||
open-webui:
|
||||
```
|
||||
|
||||
In this example, Watchtower is integrated with the `docker-compose.yml` file and watches the Open WebUI container for updates every 5 minutes.
|
||||
|
||||
## Persistent Data in Docker Volumes
|
||||
|
||||
The data is stored in a Docker volume named `open-webui`. The path to the volume is not directly accessible, but you can inspect the volume with the following command:
|
||||
|
||||
```bash
|
||||
docker volume inspect open-webui
|
||||
```
|
||||
|
||||
This will show you the details of the volume, including the mountpoint, which is usually located in `/var/lib/docker/volumes/open-webui/_data`.
|
||||
@ -1,23 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: "🧑💻 Using OpenWebUI"
|
||||
---
|
||||
|
||||
# Using OpenWebUI
|
||||
|
||||
Explore the essential concepts and features of Open WebUI, including models, knowledge, prompts, pipes, actions, and more.
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Additional Resources and Integrations
|
||||
Find community tools, integrations, and official resources.
|
||||
[Additional Resources Guide](./resources)
|
||||
|
||||
## 📖 Community Tutorials
|
||||
If you like the documentation you are reading right now, then check out this tutorial on [Configuring RAG with OpenWebUI Documentation](../../tutorials/tips/rag-tutorial.md).
|
||||
Then go on to explore other community-submitted tutorials to enhance your OpenWebUI experience.
|
||||
[Explore Community Tutorials](/category/-tutorials)
|
||||
|
||||
---
|
||||
|
||||
Stay tuned for more updates as we continue to expand these sections!
|
||||
@ -1,39 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: "🌐 Additional Resources"
|
||||
---
|
||||
|
||||
# 🌐 Additional Resources
|
||||
|
||||
Explore more resources, community tools, and integration options to make the most out of Open WebUI.
|
||||
|
||||
---
|
||||
|
||||
## 🔥 Open WebUI Website
|
||||
Visit [Open WebUI](https://openwebui.com/) for official documentation, tools, and resources:
|
||||
- **Leaderboard**: Check out the latest high-ranking models, tools, and integrations.
|
||||
- **Featured Models and Tools**: Discover models and tools created by community members.
|
||||
- **New Integrations**: Find newly released integrations, plugins, and models to expand your setup.
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Community Platforms
|
||||
Connect with the Open WebUI community for support, tips, and discussions.
|
||||
|
||||
- **Discord**: Join our community on Discord to chat with other users, ask questions, and stay updated.
|
||||
[Join the Discord Server](https://discord.com/invite/5rJgQTnV4s)
|
||||
- **Reddit**: Follow the Open WebUI subreddit for announcements, discussions, and user-submitted content.
|
||||
[Visit Reddit Community](https://www.reddit.com/r/OpenWebUI/)
|
||||
- **GitHub Community**: Participate in discussions, propose feature requests, and report issues specific to the Open WebUI Community Platform website.
|
||||
[Explore the GitHub Community](https://github.com/open-webui/community)
|
||||
|
||||
---
|
||||
|
||||
## 📖 Tutorials and User Guides
|
||||
Explore community-created tutorials to enhance your Open WebUI experience:
|
||||
- [Explore Community Tutorials](/category/-tutorials)
|
||||
- Learn how to configure RAG and advanced integrations with the [RAG Configuration Guide](../../tutorials/tips/rag-tutorial.md).
|
||||
|
||||
---
|
||||
|
||||
Stay connected and make the most out of Open WebUI through these community resources and integrations!
|
||||
Loading…
Reference in New Issue
Block a user