From 2e04574971b3cada17e20c829751c3892d36d76b Mon Sep 17 00:00:00 2001
From: Roger Gonzalez <roger@rogs.me>
Date: Thu, 5 Dec 2024 17:23:15 -0300
Subject: [PATCH] Add Cleanmedia integration for automated media management

---
 MEDIA_MANAGEMENT.md | 92 +++++++++++++++++++++++++++++++++++++++++++++
 README.md           | 12 +++++-
 docker-compose.yml  | 12 ++++++
 3 files changed, 114 insertions(+), 2 deletions(-)
 create mode 100644 MEDIA_MANAGEMENT.md

diff --git a/MEDIA_MANAGEMENT.md b/MEDIA_MANAGEMENT.md
new file mode 100644
index 0000000..771e1b1
--- /dev/null
+++ b/MEDIA_MANAGEMENT.md
@@ -0,0 +1,92 @@
+# Cleanmedia Setup Guide
+
+This guide will help you set up Cleanmedia for your Dendrite Matrix server. Cleanmedia is a data retention policy tool that helps manage media storage by implementing configurable retention policies for both remote and local media files.
+
+## Prerequisites
+
+Before starting, ensure that:
+- Dendrite is properly configured and running.
+- You have the correct file paths for your media storage.
+- You understand which media files you want to retain/remove.
+
+## Configuration Options
+
+You can customize Cleanmedia's behavior through environment variables in your docker-compose file:
+
+### CRON
+
+The `CRON` variable determines when Cleanmedia will run its cleanup routine. Examples:
+
+```yaml
+environment:
+  - CRON=0 0 * * *    # Daily at midnight (default)
+  - CRON=0 */6 * * *  # Every 6 hours
+  - CRON=0 0 */2 * *  # Every 2 days at midnight
+  - CRON=0 0 * * 0    # Weekly on Sunday at midnight
+  - CRON=0 12 * * 1-5 # Weekdays at noon
+```
+
+### CLEANMEDIA_OPTS
+
+The `CLEANMEDIA_OPTS` variable controls how Cleanmedia performs its cleanup:
+
+- `-c /etc/dendrite/dendrite.yaml`: Path to your Dendrite configuration file. Leave it as is.
+- `-t 30`: Keep media for 30 days (adjust number as needed).
+- `-l`: Include local user media in cleanup (optional).
+- `-n`: Dry run mode - simulates cleanup without deleting files.
+- `-d`: Debug mode for more verbose output.
+
+### Example Configurations
+
+1. Conservative cleanup (90-day retention, remote media only):
+```yaml
+environment:
+  - CRON=0 0 * * *  # Daily at midnight
+  - CLEANMEDIA_OPTS=-c /etc/dendrite/dendrite.yaml -t 90
+```
+
+2. Aggressive cleanup (7-day retention, including local media):
+```yaml
+environment:
+  - CRON=0 */12 * * *  # Twice daily
+  - CLEANMEDIA_OPTS=-c /etc/dendrite/dendrite.yaml -t 7 -l
+```
+
+3. Test run (dry run with debug output):
+```yaml
+environment:
+  - CRON=0 0 * * *  # Daily at midnight
+  - CLEANMEDIA_OPTS=-c /etc/dendrite/dendrite.yaml -t 30 -l -n -d
+```
+
+## Important Notes
+
+- Always test new configurations with the `-n` (dry run) flag first.
+- Local media cleanup (`-l` flag) should be used with caution as files might not be retrievable after deletion.
+- User avatars are automatically preserved.
+- The service depends on the monolith service being available.
+- Volume mounts must match your Dendrite configuration.
+
+## Troubleshooting
+
+1. **Missing Files**
+   - Verify volume mount paths match your Dendrite configuration.
+   - Check file permissions in mounted directories.
+   - Ensure Dendrite service is running properly.
+
+2. **Service Won't Start**
+   - Check logs: `docker compose logs cleanmedia`.
+   - Verify Dendrite configuration file path.
+   - Ensure monolith service is running.
+
+3. **Unexpected Deletions**
+   - Always test with `-n` flag first.
+   - Review debug logs with `-d` flag.
+   - Check retention period settings.
+
+## Next Steps
+
+For more detailed information about Cleanmedia features and configuration options, visit the [Cleanmedia documentation](https://gitlab.com/rogs/cleanmedia).
+
+Proceed to set up the [Whatasapp Bridge](../mautrix-whatsapp/README.md).
+
diff --git a/README.md b/README.md
index dbdf9aa..be9ff55 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # Dendrite Docker Bridges
 
-A simple way to set up Dendrite with bridges for WhatsApp, Telegram, and Discord.
+A simple way to set up Dendrite with bridges for WhatsApp, Telegram, and Discord, including automated media management.
 
 ## Before Starting
 
@@ -10,6 +10,13 @@ A simple way to set up Dendrite with bridges for WhatsApp, Telegram, and Discord
 
 3. All commands will be executed in the project root, i.e., the directory where the repository was cloned.
 
+## Features
+
+- Integrated bridges for WhatsApp, Telegram, and Discord
+- Automated media management with Cleanmedia
+- Simple setup process with provided scripts
+- Docker-based deployment for easy maintenance
+
 ## Installation
 
 1. Clone this repository and enter the directory:
@@ -80,8 +87,9 @@ You can run this script multiple times to create additional users as needed.
 
 ## That's It!
 
-Dendrite is now up and running! You can proceed with setting up the bridges:
+Dendrite is now up and running! You can proceed with setting up the media management and bridges:
 
+- [Media Management](./MEDIA_MANAGEMENT.md)
 - [WhatsApp Bridge](./config/mautrix-whatsapp/README.md)
 - [Telegram Bridge](./config/mautrix-telegram/README.md)
 - [Discord Bridge](./config/mautrix-discord/README.md)
diff --git a/docker-compose.yml b/docker-compose.yml
index 38f7b77..d87ce01 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -64,3 +64,15 @@ services:
     depends_on:
       postgres:
         condition: service_healthy
+
+  cleanmedia:
+    hostname: cleanmedia
+    image: rogsme/cleanmedia
+    volumes:
+      - ./config/dendrite:/etc/dendrite
+      - ./config/media:/var/dendrite/media
+    environment:
+      - CRON=0 0 * * *
+      - CLEANMEDIA_OPTS=-c /etc/dendrite/dendrite.yaml -t 30 -l
+    depends_on:
+      - monolith