diff --git a/docs/admin/maintenance/uninstall.md b/docs/admin/maintenance/uninstall.md new file mode 100644 index 00000000..5df2f52c --- /dev/null +++ b/docs/admin/maintenance/uninstall.md @@ -0,0 +1,81 @@ +--- +sidebar_position: 4 +id: uninstall +title: "Uninstall" +description:: "Guide to uninstall OpenCloud." +--- + +# Uninstall OpenCloud with Docker Compose + +> ⚠️ **Warning:** This guide will completely remove all OpenCloud data. Make sure to back up any important files before proceeding. + +--- + +## Step 1: Stop and Remove Docker Containers + +Navigate to your `opencloud-compose` directory (where your `docker-compose.yml` file is located), then run: + +```bash +docker compose down +``` + +To also remove unnamed volumes and orphan containers: + +```bash +docker compose down --volumes --remove-orphans +``` + +## Step 2: Remove Docker Volumes + +To check your existing volumes: + +```bash +docker volume ls +``` +Typical OpenCloud volumes may include: + +`opencloud_compose_opencloud-data` + +`opencloud_compose_opencloud-config` + +To delete specific volumes: + +```bash +docker volume rm opencloud_compose_opencloud-data opencloud_compose_opencloud-config +``` + +Or to clean up all unused volumes (be careful!): + +```bash +docker volume prune +``` + +## Step 3: Delete Mounted Directories (if used) + +If your .env referenced local folders such as /mnt/opencloud/data, you should delete those manually: + +```bash +sudo rm -rf /mnt/opencloud/data +sudo rm -rf /mnt/opencloud/config +``` +Adjust the paths to match your setup. + +## Step 4: Remove the Compose Project Folder (Optional) + +If you want to delete the entire project directory: + +```bash +cd .. +rm -rf opencloud-compose +``` + +## Result +After completing these steps, OpenCloud is fully removed, including: + +- All Docker containers + +- All persistent volumes + +- Any local folders and mounts + +- Optional project directory