From 4609ec5e896be4cf52ff569a453250c5aa07ee08 Mon Sep 17 00:00:00 2001 From: kelin Date: Thu, 15 Jan 2026 20:11:41 -0500 Subject: [PATCH] Update getting-started.md with manual changes - Add monitoring services section with Dockge and Uptime Kuma - Simplify stack removal instructions in service management section - Streamline documentation structure --- docs/getting-started.md | 107 +++++++++------------------------------- 1 file changed, 24 insertions(+), 83 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index f0ad439..8503a6d 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -303,11 +303,34 @@ echo | openssl s_client -connect yourdomain.duckdns.org:443 -servername any-subd - Configuring Traefik routing - Managing Docker stacks +- ## Monitoring services + - Use Dockge to easily view live container logs + - Configure Uptime Kuma to provide uptime tracking with dashboards + ## Debloat or add custom service -Tell the AI what service you want to install or give it a docker based github repository or docker hub image. +Tell the AI what service you want to install +give it a docker based github repository or docker hub image. Use your imagination, the copilot instructions are configured with best practices and a framework to add new services. +### To remove a stack + ```bash + cd /opt/stacks/stack-name + docker compose down + cd .. + sudo rm -rf stack-name + ``` +### To remove the volumes/resources for the stack + ```bash + # Stop stack and remove everything + cd /opt/stacks/stack-name + docker compose down -v --remove-orphans + + # Remove unused Docker resources + docker system prune -a --volumes + ``` + + ## Troubleshooting ### Script Issues @@ -337,88 +360,6 @@ docker compose logs -f docker compose up -d --build service-name ``` -## Managing Docker Stacks - -### Removing a Stack - -**Important:** Simply deleting the folder is NOT enough! You must properly stop the containers first. - -#### Safe Stack Removal Process: - -1. **Navigate to the stack directory:** - ```bash - cd /opt/stacks/stack-name - ``` - -2. **Stop and remove containers:** - ```bash - docker compose down - ``` - -3. **Optional: Remove volumes (WARNING: This deletes all data!):** - ```bash - docker compose down -v # Removes named volumes - ``` - -4. **Optional: Remove images:** - ```bash - docker compose down --rmi all # Removes all images used by the stack - ``` - -5. **Delete the stack folder:** - ```bash - cd /opt/stacks - sudo rm -rf stack-name - ``` - -#### Complete Cleanup (Including Orphaned Resources): - -```bash -# Stop stack and remove everything -cd /opt/stacks/stack-name -docker compose down -v --remove-orphans - -# Remove unused Docker resources -docker system prune -a --volumes - -# Remove specific images if needed -docker rmi image-name:tag -``` - -### Before Removing a Stack: - -- **Backup important data** from volumes or bind mounts -- **Check dependencies** - other services might rely on this stack -- **Review Traefik routes** - remove any custom routing rules -- **Check network usage** - stacks might create custom networks - -### What Happens If You Just Delete the Folder? - -- **Containers keep running** - they'll continue consuming resources -- **Data remains** - volumes and bind mounts are preserved -- **Networks persist** - custom networks aren't automatically cleaned up -- **Zombie processes** - orphaned containers may cause conflicts - -**Always use `docker compose down` before deleting the folder!** - -### Restoring a Removed Stack: - -If you accidentally removed a stack and want it back: - -1. **Check if it's in the repository:** - ```bash - cd ~/AI-Homelab/docker-compose - ls -la stack-name.yml - ``` - -2. **Redeploy from Dockge** or run: - ```bash - cd ~/AI-Homelab/docker-compose - cp stack-name.yml /opt/stacks/ - cd /opt/stacks/stack-name - docker compose up -d - ``` - ## Next Steps 1. **Explore services** through Dockge