From 7a04bfd0e20aaec461c92a229ce758dba227ae8c Mon Sep 17 00:00:00 2001 From: DrMelone <27028174+Classic298@users.noreply.github.com> Date: Sun, 21 Dec 2025 19:09:09 +0100 Subject: [PATCH] fix --- docs/features/interface/webhooks.md | 13 +++++++++ .../quick-start/tab-docker/DockerCompose.md | 27 ++++++++++++++++++- .../quick-start/tab-docker/ManualDocker.md | 20 ++++++++++++++ .../quick-start/tab-docker/Podman.md | 20 ++++++++++++++ .../quick-start/tab-kubernetes/Helm.md | 13 +++++++++ .../quick-start/tab-python/Conda.md | 13 +++++++++ .../quick-start/tab-python/Uv.md | 19 +++++++++++++ .../quick-start/tab-python/Venv.md | 14 ++++++++++ 8 files changed, 138 insertions(+), 1 deletion(-) diff --git a/docs/features/interface/webhooks.md b/docs/features/interface/webhooks.md index e6bc640d..16b017f4 100644 --- a/docs/features/interface/webhooks.md +++ b/docs/features/interface/webhooks.md @@ -64,6 +64,19 @@ This webhook allows individual users to receive a notification when a model has The notification is only sent if you are **not actively using the WebUI**. If you have the tab open and focused, the webhook will not be triggered, preventing unnecessary notifications. +### Enabling/Disabling User Webhooks + +User webhooks are enabled by default. However, administrators can disable this feature for all users to prevent external requests or for security reasons. + +This can be done in two ways: + +1. **Directly in the Admin Panel:** + - Go to **Admin Panel > Settings > General > Features**. + - Toggle the switch for **"User Webhooks"**. + +2. **Using Environment Variables:** + - Set the environment variable `ENABLE_USER_WEBHOOKS` to `False` in your backend configuration. This will globally disable the feature and hide the setting from user profiles. + ### Configuration 1. Click on your profile picture in the bottom-left corner to open the settings menu. diff --git a/docs/getting-started/quick-start/tab-docker/DockerCompose.md b/docs/getting-started/quick-start/tab-docker/DockerCompose.md index da1dbdc2..2e4b30ef 100644 --- a/docs/getting-started/quick-start/tab-docker/DockerCompose.md +++ b/docs/getting-started/quick-start/tab-docker/DockerCompose.md @@ -74,8 +74,33 @@ deploy: reservations: devices: - driver: nvidia - count: all + - count: all capabilities: [gpu] ``` This setup ensures that your application can leverage GPU resources when available. + +## Uninstall + +To uninstall Open WebUI running with Docker Compose, follow these steps: + +1. **Stop and Remove the Services:** + Run this command in the directory containing your `docker-compose.yml` file: + ```bash + docker compose down + ``` + +2. **Remove the Volume (Optional, WARNING: Deletes all data):** + If you want to completely remove your data (chats, settings, etc.): + ```bash + docker compose down -v + ``` + Or manually: + ```bash + docker volume rm _open-webui + ``` + +3. **Remove the Image (Optional):** + ```bash + docker rmi ghcr.io/open-webui/open-webui:main + ``` diff --git a/docs/getting-started/quick-start/tab-docker/ManualDocker.md b/docs/getting-started/quick-start/tab-docker/ManualDocker.md index bfd2c51e..26370a85 100644 --- a/docs/getting-started/quick-start/tab-docker/ManualDocker.md +++ b/docs/getting-started/quick-start/tab-docker/ManualDocker.md @@ -82,3 +82,23 @@ After the container is running, access Open WebUI at: [http://localhost:3000](http://localhost:3000) For detailed help on each Docker flag, see [Docker's documentation](https://docs.docker.com/engine/reference/commandline/run/). + +## Uninstall + +To uninstall Open WebUI running with Docker, follow these steps: + +1. **Stop and Remove the Container:** + ```bash + docker rm -f open-webui + ``` + +2. **Remove the Image (Optional):** + ```bash + docker rmi ghcr.io/open-webui/open-webui:main + ``` + +3. **Remove the Volume (Optional, WARNING: Deletes all data):** + If you want to completely remove your data (chats, settings, etc.): + ```bash + docker volume rm open-webui + ``` diff --git a/docs/getting-started/quick-start/tab-docker/Podman.md b/docs/getting-started/quick-start/tab-docker/Podman.md index 90f7edef..58db332f 100644 --- a/docs/getting-started/quick-start/tab-docker/Podman.md +++ b/docs/getting-started/quick-start/tab-docker/Podman.md @@ -48,3 +48,23 @@ Once inside Open WebUI, navigate to **Settings > Admin Settings > Connections** `http://host.containers.internal:11434` Refer to the Podman [documentation](https://podman.io/) for advanced configurations. + +## Uninstall + +To uninstall Open WebUI running with Podman, follow these steps: + +1. **Stop and Remove the Container:** + ```bash + podman rm -f openwebui + ``` + +2. **Remove the Image (Optional):** + ```bash + podman rmi ghcr.io/open-webui/open-webui:main + ``` + +3. **Remove the Volume (Optional, WARNING: Deletes all data):** + If you want to completely remove your data (chats, settings, etc.): + ```bash + podman volume rm open-webui + ``` diff --git a/docs/getting-started/quick-start/tab-kubernetes/Helm.md b/docs/getting-started/quick-start/tab-kubernetes/Helm.md index 44e064ed..f0272cbd 100644 --- a/docs/getting-started/quick-start/tab-kubernetes/Helm.md +++ b/docs/getting-started/quick-start/tab-kubernetes/Helm.md @@ -49,3 +49,16 @@ If you run Open WebUI with multiple replicas/pods (`replicaCount > 1`) or `UVICO ## Access the WebUI Set up port forwarding or load balancing to access Open WebUI from outside the cluster. + +## Uninstall + +1. **Uninstall the Helm Release:** + ```bash + helm uninstall openwebui + ``` + +2. **Remove Persistent Volume Claims (WARNING: Deletes all data):** + Helm does not automatically delete PVCs to prevent accidental data loss. You must delete them manually if you want to wipe everything. + ```bash + kubectl delete pvc -l app.kubernetes.io/instance=openwebui + ``` diff --git a/docs/getting-started/quick-start/tab-python/Conda.md b/docs/getting-started/quick-start/tab-python/Conda.md index a423a143..df185cbc 100644 --- a/docs/getting-started/quick-start/tab-python/Conda.md +++ b/docs/getting-started/quick-start/tab-python/Conda.md @@ -31,3 +31,16 @@ If your terminal says the command doesn't exist: 2. If you still get an error, try running it via Python directly: `python -m open_webui serve` 3. If you want to store your data in a specific place, use (Linux/Mac): `DATA_DIR=./data open-webui serve` or (Windows): `$env:DATA_DIR=".\data"; open-webui serve` ::: + +## Uninstall + +1. **Remove the Conda Environment:** + ```bash + conda remove --name open-webui --all + ``` + +2. **Remove Data (WARNING: Deletes all data):** + Delete your data directory (usually `~/.open-webui` unless configured otherwise): + ```bash + rm -rf ~/.open-webui + ``` diff --git a/docs/getting-started/quick-start/tab-python/Uv.md b/docs/getting-started/quick-start/tab-python/Uv.md index 24ca3942..bea48deb 100644 --- a/docs/getting-started/quick-start/tab-python/Uv.md +++ b/docs/getting-started/quick-start/tab-python/Uv.md @@ -37,3 +37,22 @@ Once `uv` is installed, running Open WebUI is a breeze. Use the command below, e :::tip Why set DATA_DIR? Setting `DATA_DIR` ensures your chats and settings are saved in a predictable location. If you don't set it, `uvx` might store it in a temporary folder that gets deleted when the process ends. ::: + +## Uninstall + +To remove Open WebUI when running with `uvx`: + +1. **Stop the Server:** + Press `Ctrl+C` in the terminal where it's running. + +2. **Available cleanup commands:** + The `uvx` command runs the application ephemerally or from cache. To remove cached components: + ```bash + uv cache clean + ``` + +3. **Remove Data (WARNING: Deletes all data):** + Delete your data directory (default is `~/.open-webui` or the path set in `DATA_DIR`): + ```bash + rm -rf ~/.open-webui + ``` diff --git a/docs/getting-started/quick-start/tab-python/Venv.md b/docs/getting-started/quick-start/tab-python/Venv.md index 130727be..5ad49bd6 100644 --- a/docs/getting-started/quick-start/tab-python/Venv.md +++ b/docs/getting-started/quick-start/tab-python/Venv.md @@ -43,3 +43,17 @@ If your terminal says the command doesn't exist: 2. If you still get an error, try running it via Python directly: `python -m open_webui serve` 3. If you want to store your data in a specific place, use: `DATA_DIR=./data open-webui serve` ::: + +## Uninstall + +1. **Delete the Virtual Environment:** + Simply remove the `venv` folder: + ```bash + rm -rf venv + ``` + +2. **Remove Data (WARNING: Deletes all data):** + Delete your data directory (usually `~/.open-webui` unless configured otherwise): + ```bash + rm -rf ~/.open-webui + ```