Home
It could be easiarr.
Welcome to the official easiarr wiki! This is your comprehensive guide to setting up and managing your *arr media ecosystem using the easiarr TUI tool.
easiarr is a terminal-based wizard that generates optimized Docker Compose configurations for your complete media server stack. It follows best practices from TRaSH Guides and supports 49 applications across 10 categories.
| Feature | Description |
|---|---|
| 📦 Quick Setup Wizard | Get started in minutes with a guided setup flow |
| 🐳 Docker Compose Generation | Automatically generates optimized docker-compose.yml
|
| ✅ TRaSH Guides Compliant | Follows best practices for folder structure and hardlinks |
| 🔄 Recyclarr & Profilarr | Automated TRaSH Guides profile sync |
| 🎮 Container Control | Start, stop, and restart containers directly from the TUI |
| 📋 Container Logs Viewer | View and save Docker container logs from the TUI |
| ⚙️ App Management | Add or remove apps from your stack with ease |
| 💾 Persistent Configuration | Settings saved to ~/.config/easiarr/config.json
|
| 🔀 Reverse Proxy | Traefik or Caddy support with automatic SSL |
| ☁️ Cloudflare Tunnel | Secure external access without port forwarding |
| 🛡️ VPN Support | Route containers through VPN via Gluetun |
| 🖥️ Unraid Support | Automatic OS detection and compatibility |
- Installation - How to install easiarr
- Quick-Start - Get up and running in 5 minutes
- Requirements - System requirements and dependencies
- Applications-Overview - Complete list of supported apps
- Servarr-Apps - Media managers (Radarr, Sonarr, etc.)
- Indexers - Prowlarr, Jackett, FlareSolverr
- Download-Clients - qBittorrent, SABnzbd
- Media-Servers - Plex, Jellyfin, Tautulli
- Dashboards - Homepage, Homarr, Heimdall
- Infrastructure - Traefik, Cloudflared, Authentik
- Utilities - Portainer, Huntarr, Unpackerr
- Monitoring - Grafana, Prometheus, Uptime Kuma
- VPN - Gluetun VPN routing
- Cloudflare-Tunnel-Setup - Expose services securely
- TRaSH-Guides-Integration - Quality profiles and best practices
- VPN-Configuration - Route traffic through VPN
- Traefik-Setup - Reverse proxy configuration
- Caddy-Setup - Alternative reverse proxy
- Configuration - Configuration file reference
- Environment-Variables - All environment variables
- Troubleshooting - Common issues and solutions
- FAQ - Frequently asked questions
- Development - Setting up development environment
- Contributing - How to contribute to easiarr
easiarr supports 49 applications organized into 10 categories:
| Category | Apps |
|---|---|
| Servarr | Radarr, Sonarr, Lidarr, Readarr, Bazarr, Mylar3, Whisparr, Audiobookshelf |
| Indexers | Prowlarr, Jackett, FlareSolverr |
| Download Clients | qBittorrent, SABnzbd |
| Media Servers | Plex, Jellyfin, Tautulli, Tdarr |
| Request Management | Overseerr, Jellyseerr |
| Dashboards | Homepage, Homarr, Heimdall |
| Utilities | Portainer, Huntarr, Unpackerr, Recyclarr, Profilarr, FileBot, Chromium, Guacamole, DDNS-Updater |
| VPN | Gluetun |
| Monitoring | Grafana, Prometheus, Dozzle, Uptime Kuma |
| Infrastructure | Traefik, Caddy, Cloudflared, Traefik Certs Dumper, CrowdSec, Headscale, Headplane, Tailscale, Authentik, PostgreSQL, Valkey |
# Run directly with bunx (no installation required)
bunx @muhammedaksam/easiarr
# Or install globally
bun add -g @muhammedaksam/easiarr
easiarrSee the Quick-Start guide for detailed instructions.
- TRaSH Guides - Quality guides for Radarr, Sonarr, and more
- OpenTUI - Terminal UI framework used by easiarr
- GitHub Repository - Source code and issues
- npm Package - Published package
Work In Progress - This project is in early experimental development. Features may be incomplete, unstable, or change without notice.
This project is licensed under the MIT License - see the LICENSE file for details.
easiarr - It could be easiarr | GitHub | npm | TRaSH Guides
