easiarr

It could be easiarr.

⚠️ Work In Progress - This project is in early experimental development. Features may be incomplete, unstable, or change without notice.

TUI tool for generating docker-compose files for the *arr media ecosystem with 52 apps, TRaSH Guides best practices, VPN routing, and Traefik/Caddy reverse proxy support.

A terminal-based wizard that helps you set up Radarr, Sonarr, Prowlarr, and other *arr applications with Docker Compose, following best practices from TRaSH Guides.

Features

• 📦 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 $XDG_CONFIG_HOME/easiarr/config.json
• 🔀 Reverse Proxy - Traefik or Caddy support with automatic SSL
• 🖥️ Unraid Support - Automatic OS detection and compatibility

Quick Start

Run directly with bunx (no installation required)

bunx @muhammedaksam/easiarr

Or install globally

bun add -g @muhammedaksam/easiarr
easiarr

Or clone and run locally

git clone https://github.com/muhammedaksam/easiarr.git
cd easiarr
bun install
bun run start

Requirements

• Bun >= 1.0
• Docker with Docker Compose v2

Supported Applications (52 apps across 10 categories)

Media Management (Servarr)

• Radarr - Movie collection manager
• Sonarr - TV series collection manager
• Lidarr - Music collection manager
• Readarr - Book collection manager
• Bazarr - Subtitle manager for Sonarr/Radarr
• Mylar3 - Comic book collection manager
• Whisparr - Adult media collection manager
• Audiobookshelf - Audiobook and podcast server

Indexers

• Prowlarr - Indexer manager for *arr apps
• Jackett - Alternative indexer manager
• FlareSolverr - Cloudflare bypass proxy

Download Clients

• qBittorrent - BitTorrent client
• SABnzbd - Usenet downloader
• Slskd - Soulseek client for music sharing
• Soularr - Lidarr integration for Soulseek

Media Servers

• Plex - Media server with streaming
• Jellyfin - Free open-source media server
• Tautulli - Plex monitoring and statistics
• Tdarr - Audio/video transcoding automation

Request Management

• Overseerr - Request management for Plex
• Jellyseerr - Request management for Jellyfin

Dashboards

• Homarr - Modern dashboard for all services
• Heimdall - Application dashboard and launcher
• Homepage - Highly customizable application dashboard

Utilities

• Portainer - Docker container management UI
• Huntarr - Missing content manager for *arr apps
• Unpackerr - Archive extraction for *arr apps
• Maintainerr - Automated media cleanup manager
• Recyclarr - TRaSH Guides profile sync (CLI-based)
• Profilarr - TRaSH Guides profile sync (Web UI)
• FileBot - Media file renaming and automator
• Chromium - Web browser for secure remote browsing
• Guacamole - Clientless remote desktop gateway
• DDNS-Updater - Dynamic DNS record updater

VPN

• Gluetun - VPN client container for routing traffic

Monitoring

• Grafana - Visual monitoring dashboard
• Prometheus - Systems and service monitoring
• Dozzle - Real-time log viewer for Docker containers
• Uptime Kuma - Self-hosted monitoring tool

Infrastructure

• Traefik - Reverse proxy and load balancer
• Caddy - Automatic HTTPS reverse proxy
• Cloudflared - Cloudflare Tunnel for secure external access
• Traefik Certs Dumper - Extracts certificates from Traefik
• CrowdSec - Intrusion prevention system
• Headscale - Open-source Tailscale control server
• Headplane - Headscale web UI
• Tailscale - VPN mesh network client
• Authentik - Identity provider and SSO
• PostgreSQL - Database server
• Valkey - Redis-compatible key-value store

Cloudflare Tunnel Setup

Expose your services securely without port forwarding using Cloudflare Tunnel.

Automated Setup (Recommended)

1. Create a Cloudflare API Token at dash.cloudflare.com/profile/api-tokens with:

   • Account:Account Settings:Read (required)
   • Account:Cloudflare Tunnel:Edit
   • Zone:DNS:Edit
   • Account:Access: Apps and Policies:Edit (optional - protects services with email login)

2. Run easiarr → Main Menu → ☁️ Cloudflare Tunnel

3. Paste your API token and follow the wizard

The wizard will automatically:

• Create the tunnel
• Add DNS records
• Configure ingress rules
• Optionally set up email authentication via Cloudflare Access

Configuration

easiarr stores its configuration in $XDG_CONFIG_HOME/easiarr/:

$XDG_CONFIG_HOME/easiarr/
├── config.json          # Your easiarr configuration
├── docker-compose.yml   # Generated Docker Compose file
└── backups/             # Configuration backups

Development

# Install dependencies
bun install

# Run in development mode (with watch)
bun run dev

# Type check
bun run typecheck

# Lint
bun run lint

# Format
bun run format

# Run all checks (typecheck + lint + format:check)
bun run check

# Fix all issues (lint:fix + format)
bun run fix

License

This project is licensed under the MIT License - see the LICENSE file for details.

Related Projects

• TRaSH Guides - Quality guides for Radarr, Sonarr, and more
• OpenTUI - Terminal UI framework used by easiarr