keepercheky
KeeperCheky
Gestor moderno de limpieza para bibliotecas multimedia - Reescritura completa de Janitorr con interfaz web
KeeperCheky automatiza la limpieza de tu biblioteca multimedia eliminando contenido antiguo o no visto según reglas configurables. Es una reescritura completa de Janitorr con interfaz web moderna, optimizado para mínimo uso de recursos.
✨ Características Principales
- 🎨 Interfaz Web Moderna - Dashboard intuitivo accesible desde cualquier navegador
- 📁 Vista Organizada - Visualización jerárquica de series/temporadas y películas con múltiples versiones
- 🧹 Limpieza Automatizada - Eliminación inteligente basada en edad y espacio en disco
- 🏷️ Reglas por Tags - Programación personalizada usando tags de Radarr/Sonarr
- 📺 Gestión de Series - Manejo especial para shows semanales/diarios
- ⏰ Próximos a Eliminar - Vista previa en Jellyfin/Emby antes de borrar
- 🔗 Integración Completa - Compatible con Radarr, Sonarr, Jellyfin, Jellyseerr, qBittorrent, Bazarr
- 🐳 Docker Ready - Despliegue sencillo con Docker Compose
- 🔒 Modo Seguro - Dry-run por defecto para prevenir accidentes
🚀 Estado del Proyecto
Fase Actual: Desarrollo Activo - v1.0.0-dev.17
✅ 90% completado - La mayoría de características implementadas
🏗️ Stack: Go + Alpine.js para máximo rendimiento y mínimos recursos
📦 Docker: ~25MB imagen, ~30-60MB RAM
⚡ Startup: <2 segundos
📚 Documentación
👉 Comenzar aquí: Índice de Documentación
Enlaces Rápidos
- Instalación y Uso - Guía de inicio rápido
- Desarrollo - Configuración del entorno de desarrollo
- Guía para Agentes IA - Instrucciones para GitHub Copilot y otros asistentes
- Resumen Ejecutivo - Visión general del proyecto
- Comparación - Janitorr vs Maintainerr vs KeeperCheky
- Propuestas Técnicas - Análisis de 4 stacks diferentes
Por qué Go + Alpine.js?
Propuesta 3 seleccionada por balance óptimo:
- ✅ Rendimiento extremo (~30-60MB RAM)
- ✅ Imagen Docker tiny (~25MB)
- ✅ Binario único, sin dependencias
- ✅ Startup instantáneo (<2s)
Ver análisis completo de las 4 propuestas evaluadas.
📦 Instalación Rápida
Opción 1: Docker Compose (Recomendado)
cd quickstart
cp .env.example .env
# Editar .env con tus configuraciones
docker-compose up -d
# Acceder a http://localhost:8780
Ver guía completa de instalación.
Opción 2: Desarrollo
git clone https://github.com/carcheky/keepercheky.git
cd keepercheky
make init
make dev
# Acceder a http://localhost:8000
Ver guía de desarrollo para más detalles.
Opción 3: Docker Manual
docker run -d \
--name keepercheky \
-p 8000:8000 \
-v ./config:/config \
-v ./data:/data \
-v /path/to/media:/media:ro \
ghcr.io/carcheky/keepercheky:latest
⚙️ Configuración Básica
# config/config.yaml
app:
dry_run: true # ⚠️ Mantener en true hasta estar seguro
leaving_soon_days: 14
scheduler_enabled: false
clients:
radarr:
enabled: true
url: "http://radarr:7878"
api_key: "tu-api-key"
jellyfin:
enabled: true
url: "http://jellyfin:8096"
api_key: "tu-api-key"
Ver ejemplo completo de configuración.
🤝 Contribuir
¿Interesado en ayudar? Revisa:
- Guía de desarrollo - Configuración y workflows
- Guía para agentes IA - Instrucciones para Copilot
- Documentación técnica - Propuestas y arquitectura
Workflow de Desarrollo
# 1. Clonar y configurar
git clone https://github.com/carcheky/keepercheky.git
cd keepercheky
make init
# 2. Hacer cambios
# ... editar código ...
# 3. SIEMPRE validar antes de commit
make validate # Valida formato, tests, build
# 4. Commit y push
git add .
git commit -m "feat: mi cambio"
git push
⚠️ IMPORTANTE: Siempre ejecuta make validate antes de cada commit. Ver guía de validación.
Áreas que necesitan ayuda
- 🧪 Tests unitarios y de integración
- 📝 Documentación y ejemplos
- 🐛 Reportar y corregir bugs
- 💡 Sugerencias de features
- 🌍 Traducciones
📝 Licencia
MIT License - Ver LICENSE para detalles
🙏 Agradecimientos
- Janitorr - Proyecto original que inspiró esta reescritura
- Maintainerr - Referencia para UI/UX y features avanzadas
- Proyectos *arr (Radarr, Sonarr, etc.)
- Comunidades de Jellyfin y Emby
Estado: v1.0.0-dev.17 - Desarrollo activo
Documentación: docs/README.md | Instalación: quickstart/README.md | Desarrollo: DEVELOPMENT.md