diff --git a/docs/getting-started/quick-start/index.mdx b/docs/getting-started/quick-start/index.mdx index f119c9e..eb588f3 100644 --- a/docs/getting-started/quick-start/index.mdx +++ b/docs/getting-started/quick-start/index.mdx @@ -21,7 +21,7 @@ import CondaWindows from './tab-python/CondaWindows.md'; -## 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 - +
@@ -49,11 +49,9 @@ Choose your preferred installation method below:
- +
- -
@@ -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! 🎉 diff --git a/docs/getting-started/quick-start/tab-docker/DockerUpdating.md b/docs/getting-started/quick-start/tab-docker/DockerUpdating.md index 5af6ba1..f3c6ef3 100644 --- a/docs/getting-started/quick-start/tab-docker/DockerUpdating.md +++ b/docs/getting-started/quick-start/tab-docker/DockerUpdating.md @@ -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. \ No newline at end of file diff --git a/docs/getting-started/quick-start/tab-docker/ManualDocker.md b/docs/getting-started/quick-start/tab-docker/ManualDocker.md index d6702fc..9454a23 100644 --- a/docs/getting-started/quick-start/tab-docker/ManualDocker.md +++ b/docs/getting-started/quick-start/tab-docker/ManualDocker.md @@ -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) \ No newline at end of file