Quick Start

⚡ Quick Start

Get your complete media server stack running in just a few minutes!

---

🎯 5-Minute Setup

Step 1: Launch easiarr

bunx @muhammedaksam/easiarr

Step 2: Run the Setup Wizard

When the TUI starts, select:

📦 Quick Setup Wizard

Step 3: Choose Your Apps

The wizard will guide you through selecting:

1. Media Root Directory - Where your media files will be stored
2. Media Managers - Radarr, Sonarr, Lidarr, etc.
3. Download Clients - qBittorrent, SABnzbd
4. Indexer - Prowlarr (recommended)
5. Media Server - Plex or Jellyfin
6. Dashboard - Homepage, Homarr, or Heimdall

Step 4: Generate Docker Compose

The wizard generates an optimized docker-compose.yml following TRaSH Guides best practices.

Step 5: Start Your Stack

From the main menu:

🎮 Container Control → Start All

Or manually:

cd ~/.config/easiarr
docker compose up -d

---

📊 Default Ports

After starting, access your services at:

Service	Port	URL
Radarr	7878	http://localhost:7878
Sonarr	8989	http://localhost:8989
Prowlarr	9696	http://localhost:9696
qBittorrent	8080	http://localhost:8080
Jellyfin	8096	http://localhost:8096
Plex	32400	http://localhost:32400/web
Homepage	3009	http://localhost:3009
Portainer	9000	http://localhost:9000

---

🔐 API Keys

View auto-discovered API keys for easy configuration:

📋 View API Keys

API keys are automatically extracted from app config files.

---

📁 Folder Structure

easiarr creates a TRaSH-compliant folder structure:

/your/media/root/
├── config/              # App configurations
│   ├── radarr/
│   ├── sonarr/
│   ├── prowlarr/
│   └── ...
└── data/
    ├── torrents/        # Active downloads
    │   ├── movies/
    │   ├── tv/
    │   └── ...
    ├── usenet/          # Usenet downloads
    │   ├── movies/
    │   ├── tv/
    │   └── ...
    └── media/           # Organized media library
        ├── movies/
        ├── tv/
        ├── music/
        └── ...

This structure enables hardlinks between download and media folders, saving disk space.

---

🎛️ Main Menu Options

Option	Description
📦 Quick Setup Wizard	Initial guided setup
🔄 Full Auto Setup	Automated setup with minimal input
⚙️ App Configurator	Configure individual app settings
➕ App Manager	Add/remove apps from stack
🎮 Container Control	Start/stop/restart containers
📋 View API Keys	Display discovered API keys
☁️ Cloudflare Tunnel	Set up secure external access
📊 Monitor Dashboard	View container status

---

🔧 Next Steps

After the initial setup:

1. Configure Prowlarr - Add indexers and sync with *arr apps

   • See Indexers for setup guide

2. Set up Download Client - Configure qBittorrent default credentials

   • Default: admin / Check docker logs for temp password
   • See Download-Clients

3. Add Media Libraries - Point your media server to the media folders

   • See Media-Servers

4. Optional: External Access - Set up Cloudflare Tunnel

   • See Cloudflare-Tunnel-Setup

5. Optional: VPN Routing - Route downloads through VPN

   • See VPN-Configuration

---

🆘 Need Help?

• Troubleshooting - Common issues and solutions
• FAQ - Frequently asked questions
• GitHub Issues - Report bugs or request features