├── static ├── prunemate.png └── prunemate-icon.svg ├── Dockerfile ├── docker-compose.yaml ├── templates ├── login.html └── index.html ├── ARCHITECTURE.md ├── CHANGELOG.md ├── README.md └── LICENSE /static/prunemate.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/anoniemerd/PruneMate/HEAD/static/prunemate.png -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.12-slim 2 | 3 | WORKDIR /app 4 | 5 | # Copy app files 6 | COPY prunemate.py /app/prunemate.py 7 | COPY templates /app/templates 8 | COPY static /app/static 9 | 10 | 11 | # Install Python dependencies (incl. Docker SDK, Gunicorn, and file-based locking) 12 | RUN pip install --no-cache-dir Flask APScheduler docker gunicorn filelock 13 | 14 | EXPOSE 8080 15 | 16 | CMD ["python", "prunemate.py"] 17 | -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | services: 2 | prunemate: 3 | build: . # Build locally instead of using pre-built image 4 | container_name: prunemate 5 | ports: 6 | - "7676:8080" 7 | volumes: 8 | - /var/run/docker.sock:/var/run/docker.sock 9 | - ./logs:/var/log 10 | - ./config:/config 11 | environment: 12 | - PRUNEMATE_TZ=Europe/Amsterdam # Change this to your desired timezone 13 | - PRUNEMATE_TIME_24H=true #false for 12-Hour format (AM/PM) 14 | # Optional: Enable authentication (generate hash with: docker run --rm anoniemerd/prunemate python prunemate.py --gen-hash "password") 15 | # - PRUNEMATE_AUTH_USER=admin 16 | # - PRUNEMATE_AUTH_PASSWORD_HASH=your_base64_encoded_hash_here 17 | restart: unless-stopped -------------------------------------------------------------------------------- /static/prunemate-icon.svg: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /templates/login.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Login - PruneMate 6 | 7 | 8 | 9 | 165 | 166 | 167 |

168 |

169 |

170 |

171 |

Sign in to PruneMate

172 |

Authentication required to continue

173 | 174 | {% with messages = get_flashed_messages() %} 175 | {% if messages %} 176 |

177 | {{ messages[0] }} 178 |

179 | {% endif %} 180 | {% endwith %} 181 | 182 | 195 | 196 | 199 |

200 | 201 | 202 | -------------------------------------------------------------------------------- /ARCHITECTURE.md: -------------------------------------------------------------------------------- 1 | # PruneMate Architecture & Design 2 | 3 | This document provides a detailed visual representation of PruneMate's internal architecture and workflow. 4 | 5 | ## System Architecture 6 | 7 | ```mermaid 8 | flowchart TD 9 | Start([PruneMate]) --> Auth{Auth
Enabled?} 10 | Auth -->|No| WebUI[Web UI
Port 8080] 11 | Auth -->|Yes| Login[Login Page
Session Auth] 12 | Login -->|Authenticated| WebUI 13 | Login -->|API Client| BasicAuth[Basic Auth
Fallback] 14 | BasicAuth -->|Valid| WebUI 15 | 16 | Start --> Scheduler[Scheduler
every minute] 17 | Start --> API[API Endpoints
/api/stats] 18 | 19 | WebUI --> |Configure| Config[(config.json
• Schedule
• Prune options
• Notifications
• Remote hosts)] 20 | WebUI --> |View Stats| StatsUI[Display stats.json
All-time metrics] 21 | WebUI --> |Manual/Preview| Manual[Manual Trigger] 22 | API --> |Homepage Widget| StatsUI 23 | 24 | Scheduler --> CheckTime{Scheduled
time?} 25 | CheckTime --> |No| Scheduler 26 | CheckTime --> |Yes| LoadConfig[Load Config] 27 | 28 | Manual --> |Preview| Preview[Get Preview
Per-host breakdown
Show resources] 29 | Preview --> |User confirms| LoadConfig 30 | 31 | LoadConfig --> Lock{Already
running?} 32 | Lock --> |Yes| Skip[Skip] 33 | Lock --> |No| CheckHosts{Remote
hosts?} 34 | 35 | CheckHosts --> |Yes| Remote[Local + Remote Hosts
via docker-socket-proxy
tcp://host:2375] 36 | CheckHosts --> |No| Local[Local Host Only
unix:///var/run/docker.sock] 37 | 38 | Remote --> CheckOptions 39 | Local --> CheckOptions 40 | 41 | CheckOptions{Check enabled
prune options} 42 | CheckOptions --> |Containers ✓| PruneC[Prune Containers
stopped/exited] 43 | CheckOptions --> |Images ✓| PruneI[Prune Images
all unused] 44 | CheckOptions --> |Networks ✓| PruneN[Prune Networks
unused] 45 | CheckOptions --> |Volumes ✓| PruneV[Prune Volumes
all unused + named] 46 | CheckOptions --> |Build Cache ✓| PruneB[Prune Build Cache
Docker builder cache] 47 | 48 | PruneC --> Aggregate 49 | PruneI --> Aggregate 50 | PruneN --> Aggregate 51 | PruneV --> Aggregate 52 | PruneB --> Aggregate 53 | 54 | Aggregate[Aggregate Results
Space + Counts] --> Stats[Update stats.json
• Total runs
• Resources deleted
• Space reclaimed
• Timestamps] 55 | 56 | Stats --> Notify{Notifications
enabled?} 57 | 58 | Notify --> |Yes + Changes| Send[Send Notification
Gotify/ntfy/Discord/Telegram
Per-host breakdown] 59 | Notify --> |No or No changes| Log[Write to
prunemate.log] 60 | Send --> Log 61 | Log --> Done[Done] 62 | 63 | style Start fill:#4a90e2 64 | style WebUI fill:#50c878 65 | style Scheduler fill:#9b59b6 66 | style Config fill:#f39c12 67 | style CheckOptions fill:#e74c3c 68 | style Stats fill:#16a085 69 | style Send fill:#3498db 70 | style Preview fill:#e67e22 71 | style API fill:#2ecc71 72 | style Remote fill:#8e44ad 73 | ``` 74 | 75 | ## Component Descriptions 76 | 77 | ### Core Components 78 | 79 | - **Web UI (Port 8080)**: Flask-based web interface for configuration and manual operations 80 | - **Scheduler**: APScheduler running every minute to check if prune should execute 81 | - **API Endpoints**: REST API for external integrations (e.g., Homepage dashboard) 82 | 83 | ### Configuration & State 84 | 85 | - **config.json**: Persistent configuration including schedule, prune options, notifications, and remote hosts 86 | - **stats.json**: Cumulative all-time statistics (space reclaimed, resources deleted, timestamps) 87 | - **prunemate.lock**: File lock to prevent concurrent prune operations 88 | - **last_run_key**: Tracks last successful scheduled run to prevent duplicates 89 | 90 | ### Prune Operations 91 | 92 | - **Containers**: Removes stopped/exited/dead containers 93 | - **Images**: Removes ALL unused images (not just dangling) using `filters={"dangling": False}` 94 | - **Networks**: Removes unused networks (excluding default bridge/host/none) 95 | - **Volumes**: Removes ALL unused volumes including named volumes using `filters={"all": True}` 96 | - **Build Cache**: Removes Docker builder cache (can reclaim significant space, 10GB+) 97 | 98 | ### Multi-Host Support 99 | 100 | - **Local Host**: Direct access via `unix:///var/run/docker.sock` 101 | - **Remote Hosts**: Secure access via docker-socket-proxy at `tcp://host:2375` 102 | - **Per-host Results**: Separate statistics and error handling for each host 103 | 104 | ### Notification Flow 105 | 106 | - **Providers**: Gotify (self-hosted), ntfy.sh (pub-sub), Discord (webhooks), or Telegram (Bot API) 107 | - **Authentication**: 108 | - Gotify: App tokens 109 | - ntfy: Bearer tokens, Basic Auth, or unauthenticated 110 | - Discord: Webhook URLs 111 | - Telegram: Bot Token + Chat ID 112 | - **Priority System**: Text-based (Low/Medium/High) with provider-specific behavior 113 | - Gotify: Numeric mapping (Low=2, Medium=5, High=8) 114 | - ntfy: Numeric mapping (Low=2, Medium=3, High=5) 115 | - Discord: Color mapping (Low=Green, Medium=Orange, High=Red) 116 | - Telegram: Notification sound (Low=Silent, Medium/High=Sound) 117 | - **Smart Notifications**: Optional "only on changes" mode to reduce noise 118 | - **Per-host Breakdown**: Detailed results for each Docker host in multi-host setups 119 | 120 | ## Workflow Explanation 121 | 122 | 1. **Trigger Sources**: 123 | - Scheduled: Minute-based scheduler checks if current time matches configured schedule 124 | - Manual: User clicks "Run now" after optionally previewing resources 125 | 126 | 2. **Preview Mode** (Manual only): 127 | - Queries each Docker host for unused resources 128 | - Shows detailed lists of what would be deleted 129 | - User must confirm before actual execution 130 | - Checkbox states auto-save when switching between preview and settings 131 | 132 | 3. **Execution**: 133 | - Acquires file lock to prevent concurrent runs 134 | - Loads latest configuration from disk 135 | - Connects to local and/or remote Docker hosts 136 | - Executes enabled prune operations per host 137 | - Aggregates results across all hosts 138 | 139 | 4. **Post-Execution**: 140 | - Updates cumulative statistics in stats.json 141 | - Sends notifications if enabled (respects "only on changes" setting) 142 | - Logs detailed results with timezone-aware timestamps 143 | - Releases file lock 144 | 145 | ## File Structure 146 | 147 | ``` 148 | /config/ 149 | ├── config.json # User configuration (persistent) 150 | ├── stats.json # All-time statistics (cumulative data) 151 | ├── prunemate.lock # Prevents concurrent runs 152 | └── last_run_key # Tracks last successful run 153 | 154 | /var/log/ 155 | └── prunemate.log # Application logs (rotating, 5MB max) 156 | ``` 157 | 158 | --- 159 | 160 | For more information, see the main [README.md](README.md). 161 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | 3 | All notable changes to PruneMate will be documented in this file. 4 | 5 | ## [V1.3.0] - December 2025 6 | 7 | ### Added 8 | - 🔐 **Optional authentication system** - Secure password protection for web interface and API 9 | - Form-based login with styled page matching app design 10 | - Scrypt password hashing (32768 iterations, industry standard) 11 | - Base64-encoded hashes to prevent Docker Compose from interpreting `$` as environment variables 12 | - Built-in hash generator: `docker run --rm anoniemerd/prunemate python prunemate.py --gen-hash "password"` 13 | - Session management with secure HttpOnly cookies 14 | - Basic Auth fallback for API clients (Homepage, Dashy, etc.) 15 | - Logout button in dashboard top-right corner 16 | - Opt-in design: only enabled when `PRUNEMATE_AUTH_PASSWORD_HASH` is set 17 | - Backward compatible: runs in open mode without auth variables 18 | - New environment variables: `PRUNEMATE_AUTH_USER` (default: admin), `PRUNEMATE_AUTH_PASSWORD_HASH` 19 | - Credit: [@difagume](https://github.com/difagume) 20 | - 🏗️ **Docker build cache pruning support** - New option to clean up Docker builder cache 21 | - Can reclaim significant disk space 22 | - Uses Docker API's `/build/prune` endpoint 23 | - Integrated into preview, statistics, and notifications 24 | - **⚠️ IMPORTANT: Docker Socket Proxy users MUST add `BUILD=1` environment variable to enable this feature** 25 | - See README for updated Docker Socket Proxy configuration 26 | - 💬 **Discord notification provider** - Full support for Discord webhook notifications 27 | - Configure via Webhook URL (from Discord server integrations) 28 | - Priority-based color coding: Low=Green, Medium=Orange, High=Red 29 | - Rich embed formatting with timestamps 30 | - Works alongside Gotify, ntfy, and Telegram providers 31 | - 📱 **Telegram notification provider** - Full support for Telegram Bot notifications 32 | - Priority support: Low=silent notifications, Medium/High=normal sound 33 | - HTML formatting for rich message display 34 | - Works alongside Gotify, ntfy, and Discord providers 35 | - 🎯 **Text-based priority system** - Changed from numeric (1-10) to text-based (Low/Medium/High) 36 | - More intuitive and user-friendly 37 | - Default priority changed from "Low" to "Medium" 38 | - Automatic migration from numeric to text priority on upgrade 39 | - Provider-specific priority mapping (e.g., Telegram uses disable_notification, Gotify uses numeric values) 40 | 41 | ### Changed 42 | - ⚙️ **Default notification priority** - Changed from "Low" to "Medium" for better visibility 43 | - All new configurations default to medium priority 44 | - Existing configurations with numeric priorities auto-migrate to text equivalents 45 | - Migration logic: 1-3→Low, 4-7→Medium, 8-10→High 46 | 47 | ### Fixed 48 | - 🔧 **Notification provider migration** - Added forward compatibility for new providers 49 | - Discord and Telegram credentials automatically added to existing configs 50 | - All provider subkeys (gotify, ntfy, discord, telegram) guaranteed to exist 51 | - Prevents errors when upgrading from older versions 52 | 53 | ## [V1.2.8] - December 2025 54 | 55 | ### Added 56 | - 🔍 **Prune preview before manual execution** - See exactly what will be deleted before running manual prune 57 | - Shows detailed list of containers, images, networks, and volumes to be removed 58 | - Per-host breakdown for multi-host setups 59 | - Two-step confirmation process for safer manual pruning 60 | - Only applies to manual "Run now" executions (scheduled runs remain automatic) 61 | - Auto-save functionality: checkbox states persist when switching between preview and settings 62 | - 🏠 **Homepage dashboard integration** - New `/api/stats` endpoint for Homepage widget support 63 | - Returns all-time statistics in customapi-compatible format 64 | - Includes human-readable space reclaimed field (`spaceReclaimedHuman`) 65 | - Relative time formatting for last run (`lastRunText` shows "2h ago", "3d ago", etc.) 66 | - Easy integration with Homepage dashboard services 67 | 68 | ### Improved 69 | - 🧹 **Image prune behavior** - Now removes ALL unused images (not just dangling) 70 | - Uses `filters={"dangling": False}` for comprehensive cleanup 71 | - Matches preview display with actual prune behavior 72 | - More aggressive space reclamation while maintaining safety 73 | - 📦 **Volume prune behavior** - Explicitly includes named volumes 74 | - Uses `filters={"all": True}` to remove all unused volumes 75 | - Named volumes are pruned alongside anonymous volumes 76 | - Preview accurately shows all volumes to be removed 77 | 78 | ### Fixed 79 | - 🐛 **Checkbox reading bug** - Preview modal now correctly reads checkbox states 80 | - Added missing `id` attributes to all four checkboxes 81 | - JavaScript `getElementById()` now works correctly 82 | - Fixed "No prune options selected" error when checkboxes were checked 83 | - 🐛 **JavaScript variable scope** - Fixed redeclaration errors in time formatting 84 | - Resolved Jinja2 template variable conflicts in 12h/24h time display 85 | - Cleaner variable naming for better maintainability 86 | 87 | --- 88 | 89 | ## [V1.2.7] - December 2025 90 | 91 | ### Added 92 | - 🔐 **ntfy authentication support** - Bearer token and Basic Auth (username:password in URL) 93 | - Priority system: Bearer token → Basic Auth → unauthenticated 94 | - RFC 3986 compliant URL parsing for embedded credentials 95 | - Optional token field in UI for ntfy provider 96 | - 🔒 **Enhanced credential security** - Passwords and tokens masked in all log output 97 | - URL credentials (username:password) redacted in logs 98 | - Bearer tokens sanitized in notification logs 99 | 100 | ### Improved 101 | - 🎨 **Logo enhancement** - Improved SVG logo design (thanks to [@shollyethan](https://github.com/shollyethan)) + added to the Self-Hosted Dashboard Icons on https://selfh.st/icons/ 102 | - 📏 Logo size increased from 76×76px to 82×82px for better visibility 103 | - 📱 **Better mobile support** - Enhanced responsive design for smartphone usage 104 | - 🔔 Notification panel height increased to 900px with enhanced scrolling behavior 105 | - 🔧 **Config migration improvements** - Deep merge strategy for nested structures 106 | - Prevents data loss during v1.2.6 → v1.2.7 upgrades 107 | - Preserves both gotify and ntfy settings in nested notifications structure 108 | - 📊 **Stats persistence improvements** - Forward-compatible field migration 109 | - Type-safe increments with defensive programming 110 | - Graceful handling of corrupt or incomplete stats files 111 | - 🏗️ **Hosts API consistency** - Local socket now included in `/hosts` endpoint response 112 | 113 | ### Fixed 114 | - 🐛 Config shallow merge bug causing nested key loss during upgrades 115 | - Replaced `dict.update()` with recursive `_deep_merge()` function 116 | - 🐛 Legacy notification migration incomplete (only migrated gotify, missed ntfy) 117 | - 🐛 Stats field migration missing for new fields in future versions 118 | - 🐛 Stats type safety issues with corrupt JSON files 119 | - 🐛 Notification panel button visibility on smaller screens 120 | 121 | --- 122 | 123 | ## [V1.2.6] - November 2025 124 | 125 | ### Added 126 | - 🐳 **Multi-host support** - Manage multiple Docker hosts from one interface 127 | - Per-host results in notifications with detailed breakdown for each Docker host 128 | - Docker hosts management UI (add, edit, enable/disable, delete external hosts) 129 | 130 | ### Improved 131 | - 🔔 Notification formatting with enhanced layout, consistent emoji usage, and bullet points 132 | - 📬 Notifications now show per-host breakdown for multi-host setups with aggregate totals 133 | - 🎯 Better visual hierarchy in notifications with clear sections and spacing 134 | - 🔧 Code quality improvements and better error handling 135 | 136 | ### Fixed 137 | - 🐛 Critical checkbox handling bug affecting all prune and notification toggles 138 | 139 | --- 140 | 141 | ## [V1.2.5] - November 2025 142 | 143 | ### Improved 144 | - 🔧 Eliminated duplicate code - moved `_validate_time()` to module level 145 | - Removed identical function definitions from `/update` and `/test-notification` routes 146 | - Renamed to `validate_time()` as public module-level function 147 | - 📝 Better log clarity for prune operations 148 | - Volumes: "Pruning volumes (unused anonymous volumes only)…" 149 | - 🧹 Moved `calendar` import from inline to top-level imports 150 | 151 | ### Fixed 152 | - 🐛 Monthly schedule bug where jobs never ran in shorter months 153 | - Jobs configured for day 30-31 now run on last day of shorter months (e.g., Feb 28/29) 154 | - Uses `calendar.monthrange()` to determine actual last day of each month 155 | - 🐛 Configuration deep copy bug causing shared nested dictionaries 156 | - All `.copy()` operations replaced with proper deep copy via `json.loads(json.dumps())` 157 | - Prevents config corruption when modifying nested notification settings 158 | - Fixed in 4 locations: initialization + 3 in `load_config()` 159 | - 🐛 KeyError in legacy Gotify config migration 160 | - Now safely checks if notifications dict exists before accessing nested keys 161 | - Uses `.get()` with fallback values to prevent crashes on old config files 162 | 163 | --- 164 | 165 | ## [V1.2.4] - November 2025 166 | 167 | ### Added 168 | - 📊 **All-Time Statistics dashboard** showing cumulative prune data 169 | - Total space reclaimed across all runs 170 | - Counters for containers, images, networks, volumes deleted 171 | - Total prune runs with first/last run timestamps 172 | - Statistics persist in `/config/stats.json` 173 | 174 | ### Improved 175 | - 📝 All functions now have proper Python docstrings for better IDE support 176 | - 🔧 Code quality improvements and better error handling 177 | 178 | ### Fixed 179 | - 🐛 12-hour time format backend handling in `/update` and `/test-notification` routes 180 | - 🐛 Minute display now shows leading zeros (e.g., "7:04" instead of "7:4") 181 | - 🐛 Time input validation now runs on page load (`initTimeClamp()`) 182 | 183 | --- 184 | 185 | ## [V1.2.3] - November 2025 186 | 187 | ### Added 188 | - 🏗️ ARM64 architecture installation instructions (Apple Silicon, ARM servers, Raspberry Pi) 189 | 190 | ### Improved 191 | - 📜 License changed from MIT to AGPLv3 192 | - 📝 All functions documented in English for better code maintainability 193 | - 📚 Documentation improvements with Quick Start guide 194 | 195 | --- 196 | 197 | ## [V1.2.2] - November 2025 198 | 199 | ### Added 200 | - ✨ 12/24-hour time format support via `PRUNEMATE_TIME_24H` environment variable 201 | - 🎨 Custom time picker for 12-hour mode (hour 1-12, minutes, AM/PM selector) 202 | 203 | ### Improved 204 | - 🌍 Timezone handling across all components (logs, scheduling, notifications) 205 | - ⚡ Simplified architecture: reduced from 2 workers to 1 for better reliability 206 | - 📝 Silent config loading to reduce log noise 207 | - 🔧 Input validation with instant clamping and 2-digit limits 208 | 209 | ### Fixed 210 | - 🐛 Config synchronization issues in multi-worker setup 211 | - 🔒 Thread-safe configuration saving with file locking 212 | 213 | --- 214 | 215 | ## [V1.2.1] - November 2025 216 | 217 | ### Improved 218 | - 🔒 Thread-safe config saving mechanism 219 | - 📊 Logging with timezone-aware timestamps 220 | 221 | ### Fixed 222 | - 🐛 Scheduler not triggering at configured times 223 | - 🔄 Config reloads before each scheduled check to ensure synchronization 224 | 225 | --- 226 | 227 | ## [V1.2.0] - November 2025 228 | 229 | ### Added 230 | - 🔔 Notification support (Gotify & ntfy.sh) 231 | - 🎯 "Only notify on changes" option 232 | - 📊 Enhanced statistics and detailed cleanup reporting 233 | 234 | ### Improved 235 | - 🎨 Complete UI redesign with modern dark theme 236 | - 🔘 Improved button animations and hover effects 237 | 238 | --- 239 | 240 | ## [V1.1.0] - October 2025 241 | 242 | ### Added 243 | - 🎉 Initial release 244 | - 🕐 Daily, Weekly, and Monthly scheduling 245 | - 🧹 Selective cleanup options (containers, images, networks, volumes) 246 | - 🌐 Web interface for configuration 247 | - 📁 Persistent configuration and logging 248 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PruneMate 2 | 3 |

4 | prunemate-logo 5 |

6 | 7 |

PruneMate

8 |

Docker image & resource cleanup helper, on a schedule!

9 | 10 |

11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 |

19 | 20 | A sleek, lightweight web interface to **automatically clean up Docker resources** on a schedule. Built with Python (Flask) · Docker SDK · APScheduler · Gunicorn 21 | 22 | **Keep your Docker host tidy with scheduled cleanup of unused images, containers, networks, and volumes.** 23 | 24 | > ⚠️ **DISCLAIMER**: PruneMate uses Docker's native `prune` commands to delete unused resources. This means it removes containers, images, networks, and volumes that Docker considers "unused" - be careful with volumes as they may contain important data. Ensure you understand what will be pruned before enabling automated schedules. The author is not responsible for any data loss or system issues. **Use at your own risk.** 25 | 26 | --- 27 | 28 | ## ✨ Features 29 | 30 | - 🕐 **Flexible scheduling** - Daily, Weekly, or Monthly cleanup runs 31 | - 🔍 **Prune preview** - See exactly what will be deleted before executing manual prune operations 32 | - 🌍 **Timezone aware** - Configure your local timezone 33 | - 🕒 **12/24-hour time format** - Choose your preferred time display 34 | - 🐳 **Multi-host support** - Manage multiple Docker hosts from one interface (requires docker-socket-proxy on remote hosts) 35 | - 🧹 **Selective cleanup** - Choose what to prune: containers, images, networks, volumes, **build cache** 36 | - 🏗️ **Build cache cleanup** - Reclaim significant space by pruning Docker builder cache (often 10GB+) 37 | - 📊 **All-Time Statistics** - Track cumulative space reclaimed and resources deleted across all runs 38 | - 🏠 **Homepage integration** - Display statistics in your Homepage dashboard 39 | - 🔔 **Smart notifications** - Gotify, ntfy.sh, Discord, or Telegram support with optional change-only alerts 40 | - 🎨 **Modern UI** - Dark theme with smooth animations and responsive design 41 | - �🔒 **Secure authentication** - Optional login protection with password hashing and Basic Auth support 42 | - �🔒 **Safe & controlled** - Manual trigger with preview and detailed logging 43 | - 📈 **Detailed reports** - See exactly what was cleaned and how much space was reclaimed 44 | 45 | --- 46 | 47 | ## 📷 Screenshots 48 | 49 | ### Main Dashboard 50 | The overall look and feel of the PruneMate dashboard 51 | 52 |

53 | 54 |

55 | 56 | ### Authentication page 57 | The login page, (when enabled in the docker-compose.yaml environment variables) 58 | 59 |

60 | 61 |

62 | 63 | ### External Docker hosts 64 | Add external Docker hosts via [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) 65 | 66 |

67 | prunemate-cleanup 68 |

69 | 70 | ### Notification Settings 71 | Set up notifications via Gotify, ntfy.sh, Discord, or Telegram to stay informed about cleanup results. 72 | 73 |

74 | prunemate-notifications 75 |

76 | 77 | ### Prune preview 78 | A brief interface that shows which Docker resources will be pruned during the next cleanup run, either manually triggered or scheduled. 79 | 80 |

81 | prunemate-preview 82 |

83 | 84 | 85 | --- 86 | 87 | ## 🚀 Quick Start with Docker Compose 88 | 89 | ### Prerequisites 90 | 91 | - Docker and Docker Compose installed 92 | - Access to Docker socket (`/var/run/docker.sock`) 93 | 94 | ### Installation 95 | 96 | 1. **Create a `docker-compose.yaml` file:** 97 | 98 | ```yaml 99 | services: 100 | prunemate: 101 | image: anoniemerd/prunemate:latest 102 | container_name: prunemate 103 | ports: 104 | - "7676:8080" 105 | volumes: 106 | - /var/run/docker.sock:/var/run/docker.sock 107 | - ./logs:/var/log 108 | - ./config:/config 109 | environment: 110 | - PRUNEMATE_TZ=Europe/Amsterdam # Change this to your desired timezone 111 | - PRUNEMATE_TIME_24H=true #false for 12-Hour format (AM/PM) 112 | # Optional: Enable authentication (generate hash with: docker run --rm anoniemerd/prunemate python prunemate.py --gen-hash "password") 113 | # - PRUNEMATE_AUTH_USER=admin 114 | # - PRUNEMATE_AUTH_PASSWORD_HASH=your_base64_encoded_hash_here 115 | restart: unless-stopped 116 | ``` 117 | 118 | **For ARM64 systems (Apple Silicon, ARM servers, Raspberry Pi):** 119 | 120 | If you get "no matching manifest for linux/arm64" error, clone the repository and build locally: 121 | 122 | ```bash 123 | # Clone the repository 124 | git clone https://github.com/anoniemerd/PruneMate.git 125 | cd PruneMate 126 | ``` 127 | 128 | Then use this docker-compose.yaml: 129 | 130 | ```yaml 131 | services: 132 | prunemate: 133 | build: . # Build locally instead of using pre-built image 134 | container_name: prunemate 135 | ports: 136 | - "7676:8080" 137 | volumes: 138 | - /var/run/docker.sock:/var/run/docker.sock 139 | - ./logs:/var/log 140 | - ./config:/config 141 | environment: 142 | - PRUNEMATE_TZ=Europe/Amsterdam # Change this to your desired timezone 143 | - PRUNEMATE_TIME_24H=true #false for 12-Hour format (AM/PM) 144 | # Optional: Enable authentication (generate hash with: docker run --rm anoniemerd/prunemate python prunemate.py --gen-hash "password") 145 | # - PRUNEMATE_AUTH_USER=admin 146 | # - PRUNEMATE_AUTH_PASSWORD_HASH=your_base64_encoded_hash_here 147 | restart: unless-stopped 148 | ``` 149 | 150 | 2. **Start PruneMate:** 151 | 152 | ```bash 153 | docker-compose up -d 154 | ``` 155 | 156 | 3. **Access the web UI of PruneMate:** 157 | 158 | Open your browser and navigate to: 159 | 160 | ``` 161 | http://:7676/ 162 | ``` 163 | 164 | --- 165 | 166 | ## 🚀 Quick Start with Docker Run 167 | 168 | **Using Docker CLI:** 169 | 170 | ```bash 171 | docker run -d \ 172 | --name prunemate \ 173 | -p 7676:8080 \ 174 | -v /var/run/docker.sock:/var/run/docker.sock \ 175 | -v $(pwd)/logs:/var/log \ 176 | -v $(pwd)/config:/config \ 177 | -e PRUNEMATE_TZ=Europe/Amsterdam \ 178 | -e PRUNEMATE_TIME_24H=true \ 179 | --restart unless-stopped \ 180 | anoniemerd/prunemate:latest 181 | ``` 182 | 183 | **Access the web UI:** 184 | 185 | ``` 186 | http://:7676/ 187 | ``` 188 | 189 | 190 | 191 | **Volume explanations:** 192 | - `/var/run/docker.sock` - Required for Docker API access 193 | - `./logs` - Stores application logs (rotating, 5MB max per file) 194 | - `./config` - Stores configuration and state files 195 | 196 | --- 197 | 198 | ## ⚙️ Configuration 199 | 200 | ### Environment Variables 201 | 202 | | Variable | Default | Description | 203 | |----------|---------|-------------| 204 | | `PRUNEMATE_TZ` | `UTC` | Timezone for scheduling (e.g., `Europe/Amsterdam`, `America/New_York`) | 205 | | `PRUNEMATE_TIME_24H` | `true` | Time format: `true` for 24-hour, `false` for 12-hour (AM/PM) | 206 | | `PRUNEMATE_CONFIG` | `/config/config.json` | Path to configuration file | 207 | | `PRUNEMATE_AUTH_USER` | `admin` | Username for authentication (optional, only used when auth is enabled) | 208 | | `PRUNEMATE_AUTH_PASSWORD_HASH` | _(none)_ | Base64-encoded password hash (enables authentication when set) | 209 | 210 | ### 🔐 Authentication (Optional) 211 | 212 | PruneMate supports optional password protection for the web interface and API endpoints. 213 | 214 | **Key features:** 215 | - 🔒 **Form-based login** - Styled login page matching the app's design 216 | - 🔑 **Secure hashing** - Passwords are hashed using scrypt (industry standard) 217 | - 🌐 **API compatibility** - Basic Auth fallback for external tools (Homepage, Dashy, etc.) 218 | - 🚪 **Logout button** - Convenient session management 219 | 220 | **To enable authentication:** 221 | 222 | 1. **Generate a password hash** using the built-in tool: 223 | 224 | ```bash 225 | docker run --rm anoniemerd/prunemate:latest python prunemate.py --gen-hash "your_password" 226 | ``` 227 | 228 | This outputs a Base64-encoded hash (safe for YAML, no special characters): 229 | ``` 230 | c2NyeXB0OjMyNzY4Ojg6MSRvcDdnZFlGR1JmRFp4Y1RjJDBmMzNlYzc4NzExZTI4MzllYjk0MWFiOTZkOGUyZGNjNGRhMzU2NTlmMGI1ZDg0NjhjZTdkMThhODhmNmQ3ZGRhOGU4YzdmMDYxMWZiNzAyYjA0ZGNhNTBjZWMxZjFlYzc3ZjhlNzJhYmM0MmQ3OTQ5NDM2MDUzZWRlZjlhZGY0 231 | ``` 232 | 233 | > **Why Base64?** Raw scrypt hashes contain `$` characters that Docker Compose interprets as environment variables, corrupting the hash. Base64 encoding produces alphanumeric strings that YAML handles safely without escaping. 234 | 235 | > **✅ Special characters that work well:** 236 | > - Hash characters: `#` 237 | > - At sign: `@` 238 | > - Percent: `%` 239 | > - Asterisk: `*` 240 | > - Ampersand: `&` 241 | > - Caret: `^` 242 | > 243 | > **⚠️ Avoid these characters:** 244 | > - Exclamation mark: `!` (bash history expansion) 245 | > - Dollar sign: `$` (variable expansion - even Base64 encoded, can cause issues in some contexts) 246 | > 247 | > **Safe examples:** 248 | > - `MyPassword#123` 249 | > - `Test@secure%pass` 250 | > - `prunemate&admin^2024` 251 | > - `MyPass*Admin#99` 252 | 253 | 2. **Add to your docker-compose.yaml:** 254 | 255 | ```yaml 256 | environment: 257 | - PRUNEMATE_AUTH_USER=admin # Optional (default: admin) 258 | - PRUNEMATE_AUTH_PASSWORD_HASH=c2NyeXB0OjMyNzY4Ojg6MSRvcDdnZFlGR1JmRFp4Y1RjJDBmMzNlYzc4... 259 | ``` 260 | 261 | 3. **Restart the container:** 262 | 263 | ```bash 264 | docker-compose up -d 265 | ``` 266 | 267 | **Important notes:** 268 | - Authentication is **opt-in** - only enabled when `PRUNEMATE_AUTH_PASSWORD_HASH` is set 269 | - Without the hash variable, the app runs in open mode (backward compatible) 270 | - For API clients (Homepage, etc.), use Basic Auth with your actual password (not the hash) 271 | - The hash is Base64-encoded to prevent Docker Compose from interpreting `$` characters as variables 272 | 273 | 274 | ### Web Interface Settings 275 | 276 | Access the web interface at `http://localhost:7676/` (or your server IP) to configure: 277 | 278 | **Schedule Settings:** 279 | - **Frequency:** Daily, Weekly, or Monthly 280 | - **Time:** When to run the cleanup (supports both 12h and 24h format) 281 | - **Day:** Day of week (for weekly) or day of month (for monthly) 282 | 283 | **Cleanup Options:** 284 | - ☑️ All unused containers 285 | - ☑️ All unused images 286 | - ☑️ All unused networks 287 | - ☑️ All unused volumes 288 | 289 | **Notification Settings:** 290 | - **Provider:** Gotify, ntfy.sh, Discord, or Telegram 291 | - **Configuration:** Provider-specific credentials (URL/Token for Gotify, URL/Topic for ntfy, Webhook URL for Discord, Bot Token/Chat ID for Telegram) 292 | - **Priority:** Low (silent), Medium, or High priority notifications (provider-dependent) 293 | - **Only notify on changes:** Only send notifications when something was actually cleaned 294 | 295 | --- 296 | 297 | ## 🧠 How it works 298 | 299 | 1. **Scheduler runs** every minute checking if it's time to execute 300 | 2. **Loads latest config** from persistent storage 301 | 3. **Executes Docker prune** commands for selected resource types 302 | 4. **Collects statistics** on what was removed and space reclaimed 303 | 5. **Updates all-time statistics** with cumulative data (space, counts, timestamps) 304 | 6. **Sends notification** (if configured and enabled) 305 | 7. **Logs everything** with timezone-aware timestamps 306 | 307 | 📊 **[View detailed architecture & flowchart](ARCHITECTURE.md)** 308 | 309 | ### File Structure 310 | 311 | ``` 312 | /config/ 313 | ├── config.json # Your configuration (persistent) 314 | ├── stats.json # All-time statistics (cumulative data) 315 | ├── prunemate.lock # Prevents concurrent runs 316 | └── last_run_key # Tracks last successful run 317 | 318 | /var/log/ 319 | └── prunemate.log # Application logs (rotating, 5MB max) 320 | ``` 321 | 322 | ### All-Time Statistics 323 | 324 | PruneMate tracks cumulative statistics across all prune runs: 325 | 326 | **Metrics tracked:** 327 | - 💾 **Total Space Reclaimed** - Cumulative disk space freed (displayed in MB/GB/TB) 328 | - 📦 **Containers Deleted** - Total count of unused containers removed 329 | - 🖼️ **Images Deleted** - Total count of unused images removed 330 | - 🔗 **Networks Deleted** - Total count of unused networks removed 331 | - 💿 **Volumes Deleted** - Total count of unused volumes removed 332 | - 🔄 **Total Prune Runs** - Number of times prune has executed 333 | - 📅 **First Run** - Timestamp of the very first prune execution 334 | - 🕐 **Last Run** - Timestamp of the most recent prune execution 335 | 336 | **Technical details:** 337 | - Statistics persist in `/config/stats.json` using atomic writes with file locking 338 | - Updates occur after every prune run, regardless of whether resources were deleted 339 | - Timestamps are timezone-aware and respect `PRUNEMATE_TZ` setting 340 | - Date/time display in UI follows configured 12h/24h format 341 | - Statistics survive container restarts and updates 342 | - Auto-refresh after manual prune runs via web interface 343 | 344 | --- 345 | 346 | ## 🔔 Notification Setup 347 | 348 | ### Gotify 349 | 350 | [Gotify](https://gotify.net/) is a self-hosted notification service. 351 | 352 | **Setup steps:** 353 | 1. Install and run Gotify server 354 | 2. Create a new application in Gotify 355 | 3. Copy the application token 356 | 4. Configure in PruneMate: 357 | - **Provider:** Gotify 358 | - **URL:** `https://your-gotify-server.com` 359 | - **Token:** Your application token 360 | 361 | ### ntfy.sh 362 | 363 | [ntfy.sh](https://ntfy.sh/) is a simple pub-sub notification service (self-hosted or public). 364 | 365 | **Setup steps:** 366 | 1. Choose a unique topic name (e.g., `prunemate-alerts`) 367 | 2. Configure in PruneMate: 368 | - **Provider:** ntfy 369 | - **URL:** `https://ntfy.sh` (or your self-hosted instance, supports `username:password@host` format) 370 | - **Topic:** Your chosen topic name 371 | - **Token:** (Optional) Bearer token for authentication 372 | 373 | **Authentication options:** 374 | - **Bearer token:** Recommended for API access tokens (higher priority) 375 | - **URL credentials:** Use `https://username:password@ntfy.example.com` format (RFC 3986 compliant) 376 | - **No authentication:** Works with public topics 377 | 378 | **Subscribe to notifications:** 379 | - **Web:** Visit `https://ntfy.sh/your-topic` 380 | - **Mobile:** Install the ntfy app ([Android](https://play.google.com/store/apps/details?id=io.heckel.ntfy) / [iOS](https://apps.apple.com/app/ntfy/id1625396347)) and subscribe to your topic 381 | - **Desktop:** Use ntfy desktop app or web browser 382 | 383 | ### Discord 384 | 385 | [Discord](https://discord.com/) webhooks allow notifications directly to your Discord server. 386 | 387 | **Setup steps:** 388 | 1. Open your Discord server settings 389 | 2. Go to **Integrations** → **Webhooks** 390 | 3. Click **New Webhook** or edit existing webhook 391 | 4. Copy the **Webhook URL** 392 | 5. Configure in PruneMate: 393 | - **Provider:** Discord 394 | - **Webhook URL:** `https://discord.com/api/webhooks/...` 395 | 396 | **Priority colors:** 397 | - **Low:** Green (informational) 398 | - **Medium:** Orange (warning) 399 | - **High:** Red (critical) 400 | 401 | ### Telegram 402 | 403 | [Telegram Bot API](https://core.telegram.org/bots) enables notifications via Telegram bots. 404 | 405 | **Setup steps:** 406 | 1. Open Telegram and search for **@BotFather** 407 | 2. Send `/newbot` and follow the instructions 408 | 3. Give your bot a name (e.g., "PruneMate Notifications") 409 | 4. Give your bot a username ending in "bot" (e.g., "prunemate_notif_bot") 410 | 5. Copy the **Bot Token** (format: `123456789:ABCdefGHIjklMNOpqrsTUVwxyz`) 411 | 6. Get your **Chat ID**: 412 | - **Easy method:** Message **@userinfobot** or **@getmyid_bot** to get your Chat ID 413 | - **Alternative:** Message your bot, then visit `https://api.telegram.org/bot/getUpdates` and find `"chat":{"id":123456789}` 414 | 7. Configure in PruneMate: 415 | - **Provider:** Telegram 416 | - **Bot Token:** Your bot token from BotFather 417 | - **Chat ID:** Your numeric chat ID (or `@channelname` for channels) 418 | 419 | **Priority behavior:** 420 | - **Low:** Silent notifications (no sound) 421 | - **Medium/High:** Normal notifications with sound 422 | 423 | **Advanced usage:** 424 | - **Groups:** Add bot to group, get group Chat ID (starts with `-`) 425 | - **Channels:** Use channel username with `@` (e.g., `@mychannel`) or numeric ID 426 | 427 | --- 428 | 429 | 430 | ## 🌐 Multi-Host Setup (Optional) 431 | 432 | PruneMate can manage multiple Docker hosts from a single interface. Each prune operation runs across all enabled hosts with aggregated results. 433 | 434 | ### Security First: Use Docker Socket Proxy 435 | 436 | ⚠️ **Never expose Docker sockets directly!** Always use [docker-socket-proxy](https://github.com/Tecnativa/docker-socket-proxy) to limit API access. 437 | 438 | ### Quick Setup 439 | 440 | **1. Deploy proxy on each remote host:** 441 | 442 | ```yaml 443 | services: 444 | dockerproxy: 445 | image: ghcr.io/tecnativa/docker-socket-proxy:latest 446 | environment: 447 | - CONTAINERS=1 448 | - IMAGES=1 449 | - NETWORKS=1 450 | - VOLUMES=1 451 | - BUILD=1 # REQUIRED FOR BUILD CACHE PRUNE 452 | - POST=1 # Required for prune operations 453 | ports: 454 | - "2375:2375" 455 | volumes: 456 | - /var/run/docker.sock:/var/run/docker.sock:ro 457 | restart: unless-stopped 458 | ``` 459 | 460 | > **⚠️ IMPORTANT:** The `BUILD=1` environment variable is **REQUIRED** to enable Docker build cache pruning. Without it, build cache prune operations will fail with a 403 error. 461 | 462 | **2. Add hosts in PruneMate UI:** 463 | - Navigate to **Docker Hosts** section 464 | - Click **Add New Host** 465 | - Enter name (e.g., "NAS") and URL (e.g., `tcp://192.168.1.50:2375`) 466 | - Toggle hosts on/off as needed 467 | 468 | **3. Test connection:** 469 | Click **Run now** and check logs for successful connection to all hosts. 470 | 471 | 472 | ### Troubleshooting 473 | 474 | - **Connection refused**: Verify proxy is running (`docker ps`) and port 2375 is accessible 475 | - **Permission denied**: Ensure proxy has `POST=1` environment variable 476 | - **Host skipped**: Check URL format starts with `tcp://`, `http://`, or `https://` 477 | 478 | --- 479 | 480 | ## 🏠 Homepage Dashboard Integration 481 | 482 | PruneMate provides a custom API endpoint at `/api/stats` that returns all-time statistics in a format compatible with [Homepage](https://gethomepage.dev/) dashboard widgets. 483 | 484 |

485 | prunemate-homepage 486 |

487 | 488 | ### Setup 489 | 490 | Add this configuration to your Homepage `services.yaml`: 491 | 492 | ```yaml 493 | - PruneMate: 494 | href: http://:7676 495 | description: Docker Cleanup Automation 496 | icon: https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/prunemate.webp 497 | widget: 498 | type: customapi 499 | url: http://:7676/api/stats 500 | mappings: 501 | - field: pruneRuns 502 | label: Prune Runs 503 | format: number 504 | - field: lastRunText 505 | label: Last Run 506 | - field: imagesDeleted 507 | label: Images Pruned 508 | format: number 509 | - field: spaceReclaimedHuman 510 | label: Space Saved 511 | ``` 512 | 513 | ### Available Fields 514 | 515 | The `/api/stats` endpoint returns the following fields: 516 | 517 | | Field | Type | Description | Homepage Format | 518 | |-------|------|-------------|-----------------| 519 | | `pruneRuns` | number | Total number of prune operations executed | `number` | 520 | | `containersDeleted` | number | Total containers deleted across all runs | `number` | 521 | | `imagesDeleted` | number | Total images deleted across all runs | `number` | 522 | | `networksDeleted` | number | Total networks deleted across all runs | `number` | 523 | | `volumesDeleted` | number | Total volumes deleted across all runs | `number` | 524 | | `buildCacheDeleted` | number | Total build cache entries deleted across all runs | `number` | 525 | | `spaceReclaimed` | number | Total space reclaimed in bytes | `number` | 526 | | `spaceReclaimedHuman` | string | Human-readable space reclaimed (e.g., "2.5 GB") | `text` | 527 | | `lastRunText` | string | Relative time as text (e.g., "2h ago") | `text` | 528 | | `lastRunTimestamp` | number | Unix timestamp in seconds of last run | `number` | 529 | | `lastRun` | string | ISO timestamp of most recent prune run | `date` | 530 | | `firstRun` | string | ISO timestamp of first prune run | `date` | 531 | 532 | ### Example /api/stats output 533 | 534 | ```json 535 | { 536 | "pruneRuns": 42, 537 | "containersDeleted": 156, 538 | "imagesDeleted": 89, 539 | "networksDeleted": 12, 540 | "volumesDeleted": 7, 541 | "buildCacheDeleted": 715, 542 | "spaceReclaimed": 5368709120, 543 | "spaceReclaimedHuman": "5.00 GB", 544 | "lastRunText": "2h ago", 545 | "lastRunTimestamp": 1733454000, 546 | "lastRun": "2025-12-06T03:00:00+01:00", 547 | "firstRun": "2025-01-15T03:00:00+01:00" 548 | } 549 | ``` 550 | --- 551 | 552 | ## 🧠 Troubleshooting 553 | 554 | | Problem | Solution | 555 | |---------|----------| 556 | | ❌ Can't access web interface | • Check if port 7676 is available and not blocked by firewall
• Verify container is running: `docker ps`
• Check logs: `docker logs prunemate` | 557 | | 🏗️ ARM architecture error | • Error: "no matching manifest for linux/arm64"
• **Solution:** Clone the repository and change `image: anoniemerd/prunemate:latest` to `build: .` in docker-compose.yaml
• This builds the image locally for your ARM64 system
• See Quick Start section for ARM64-specific instructions | 558 | | ⚙️ Container not starting | • View startup errors: `docker logs prunemate`
• Verify Docker socket is accessible
• Check if port 7676 is already in use | 559 | | 🔒 Permission denied errors | • Ensure `/var/run/docker.sock` exists and is accessible
• On Linux, Docker daemon must be running
• User running Docker must have proper permissions | 560 | | 🕐 Wrong timezone in logs/schedule | • Set `PRUNEMATE_TZ` environment variable correctly
• Restart container after changing: `docker-compose restart`
• Verify timezone in logs matches expected | 561 | | 📧 Notifications not working | • Test notification settings in web interface
• Verify notification server URL is accessible
• Check token/topic is correct
• Review logs for error messages | 562 | | 🗂️ Configuration not persisting | • Ensure `./config` volume is mounted correctly
• Check file permissions on host `./config` directory
• Verify container has write access | 563 | | 🧹 Cleanup not running on schedule | • Check schedule configuration in web interface
• Verify timezone is set correctly
• Review logs: "Next scheduled run" messages
• Ensure container is running continuously | 564 | 565 | --- 566 | 567 | ### Logging 568 | 569 | **What the logs contain:** 570 | - ✅ Scheduler heartbeats (every minute) 571 | - 📝 Configuration changes 572 | - 🧹 Prune job executions with results 573 | - 📨 Notification delivery status 574 | - ❌ Error messages and warnings 575 | 576 | --- 577 | 578 | ## 📜 Release Notes 579 | 580 | ### Version 1.2.9 (December 2025) 581 | - 🏗️ **NEW** Docker build cache pruning - Clean up Docker builder cache (can reclaim 10GB+) 582 | - **⚠️ Requires `BUILD=1` in docker-socket-proxy for remote hosts** 583 | - 💬 **NEW** Discord notification provider - Webhook-based notifications with color-coded priorities 584 | - Configure with Webhook URL from Discord server integrations 585 | - Priority colors: Low=Green, Medium=Orange, High=Red 586 | - 📱 **NEW** Telegram notification provider - Full bot notification support 587 | - Configure with Bot Token (from @BotFather) and Chat ID 588 | - Priority support: Low=silent, Medium/High=normal sound 589 | - 🎯 **NEW** Text-based priority system - Changed from numeric (1-10) to text (Low/Medium/High) 590 | - More intuitive and user-friendly 591 | - Default priority changed to "Medium" 592 | - Automatic migration from numeric priorities 593 | 594 | ### Version 1.2.8 (December 2025) 595 | - 🔍 **NEW** Prune preview before execution - See exactly what will be deleted before running 596 | - 🏠 **NEW** Homepage dashboard integration - `/api/stats` endpoint for customapi widget 597 | 598 | 📖 **[View full changelog](CHANGELOG.md)** 599 | 600 | --- 601 | 602 | ## 📬 Support 603 | 604 | Have questions or need help? 605 | 606 | - 🐛 **Bug reports:** [Open an issue on GitHub](https://github.com/anoniemerd/PruneMate/issues) 607 | - 💡 **Feature requests:** [Open an issue on GitHub](https://github.com/anoniemerd/PruneMate/issues) 608 | - 💬 **Questions & Discussion:** [Start a discussion on GitHub](https://github.com/anoniemerd/PruneMate/discussions) 609 | - ⭐ **Like PruneMate?** Give it a star! 610 | 611 | --- 612 | 613 | ## 👤 Author & License 614 | 615 | **Author:** Anoniemerd 616 | 🐙 GitHub: 617 | 📦 Repository: 618 | 619 | --- 620 | 621 | ## 👥 Contributors 622 | 623 | I'm grateful for the contributions that make PruneMate better! 624 | 625 | ### Contributors 626 | - **[@difagume](https://github.com/difagume)** - 🔐 Authentication system implementation (V1.3.0) 627 | - **[@shollyethan](https://github.com/shollyethan)** - 🎨 Logo redesign & added the logo to Self-Hosted Dashboard Icons 628 | 629 | ### Project maintainer/owner 630 | - **[anoniemerd](https://github.com/anoniemerd)** - Project creator and maintainer 631 | 632 | 633 | --- 634 | 635 | ### 📜 License — AGPLv3 636 | 637 | This project is licensed under the **GNU Affero General Public License v3.0 (AGPL-3.0)**. 638 | 639 | By using, modifying, or distributing this software, you **must**: 640 | 641 | - Keep this copyright notice 642 | - Disclose source code of any modified version 643 | - Disclose source code if used to provide a network service 644 | - License any derivative works under **AGPL-3.0** 645 | 646 | See the full license text in: [`LICENSE`](./LICENSE) 647 | 648 | ### ⚠️ Disclaimer 649 | 650 | **USE AT YOUR OWN RISK.** PruneMate is provided "as is" without warranty of any kind. The author(s) and contributors are not responsible for: 651 | - Data loss from pruned Docker resources 652 | - Service interruptions or downtime 653 | - System instability or performance issues 654 | - Any damages resulting from the use or misuse of this software 655 | 656 | Always: 657 | - ✅ Understand which resources will be deleted 658 | - ✅ Keep backups of important data and configurations 659 | - ✅ Review logs after prune operations 660 | - ✅ Start with conservative settings 661 | 662 | © 2025 – PruneMate Project 663 | 664 | --- 665 | 666 |

667 | Keep your Docker host clean with PruneMate! 🐳🧹 668 |

669 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | -------------------------------------------------------------------------------- /templates/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | PruneMate - Docker cleanup helper 6 | 7 | 8 | 9 | 10 | 12 | 13 | 306 | 307 | 308 | 309 | {% set _flashes = get_flashed_messages(with_categories=false) %} 310 | 311 |

312 | 313 | 314 |

315 | 316 | 317 | 842 | 843 | 844 | 866 | 867 | 1734 | 1735 | --------------------------------------------------------------------------------

PruneMate

All-Time Statistics

Schedule

Cleanup options

Docker Hosts

Add New Host

Notifications

🔍 Prune Preview