Utilities

🔧 Utilities

Utility applications enhance and extend your media server stack with automation, management, and specialized functionality.

---

Overview

App	Description	Port
Portainer	Docker container management UI	9000
Huntarr	Missing content manager for *arr apps	9705
Unpackerr	Archive extraction for *arr apps	5656
Recyclarr	TRaSH Guides profile sync (CLI)	N/A
Profilarr	TRaSH Guides profile sync (Web UI)	6868
Maintainerr	Automated media cleanup manager	6246
FileBot	Media file renaming and automator	5452
Chromium	Web browser for secure remote browsing	3000
Guacamole	Clientless remote desktop gateway	8080
DDNS-Updater	Dynamic DNS record updater	8000

---

Portainer

Docker container management UI - Web-based Docker management.

Features

• 🐳 Container management (start/stop/restart)
• 📊 Resource monitoring
• 📝 Log viewing
• 🔧 Stack management
• 👥 User access control
• 🖼️ Image management

Configuration

Port: 9000
Data: /data
Docker: /var/run/docker.sock

Initial Setup

1. Access Portainer at http://localhost:9000
2. Create admin account (min 12 characters)
3. Select "Local" Docker environment
4. Start managing containers!

Password Requirement

Portainer requires a minimum 12-character password. easiarr enforces this when using GLOBAL_PASSWORD.

Homepage Widget

easiarr configures Portainer widget automatically:

widget:
  type: portainer
  url: http://portainer:9000
  env: 1 # Auto-detected
  key: ${PORTAINER_API_KEY}

---

Huntarr

Missing content manager - Actively searches for missing media.

Features

• 🔍 Automated missing content search
• 📺 Multi-app support (Radarr, Sonarr, Lidarr)
• ⏰ Scheduled searches
• 📊 Progress tracking
• 🔔 Notifications

Configuration

Port: 9705
Config: /config

Setup

1. Access Huntarr at http://localhost:9705
2. Add your *arr applications with API keys
3. Configure search schedules
4. Monitor search progress

Homepage Widget

easiarr configures Huntarr widget automatically:

widget:
  type: customapi
  url: http://huntarr:9705/api/version
  mappings:
    - field: version
      label: Version

API

Huntarr exposes a minimal API:

Endpoint	Auth	Description
/api/version	None	Returns {"version": "x.x.x"}

---

Unpackerr

Archive extraction - Automatically extracts archived downloads.

Features

• 📦 Automatic archive extraction
• 🔗 *arr app integration
• 🗑️ Auto-cleanup after import
• 📊 Multiple archive format support

Configuration

Port: 5656
Config: /config
Data: /data (download directories)

Use Case

When indexers provide content as RAR archives:

1. Download client receives archive
2. Unpackerr detects the archive
3. Extracts to same location
4. *arr app imports the extracted files
5. Unpackerr cleans up

---

Recyclarr

TRaSH Guides profile sync (CLI) - Command-line tool for syncing quality profiles.

Features

• 📋 Import TRaSH Guides quality profiles
• 🔧 Full YAML configuration
• ⏰ Scheduled sync via cron
• 📊 Custom format support
• 🔄 Supports Radarr and Sonarr

Configuration

Port: N/A (CLI tool, no web UI)
Config: /config/recyclarr.yml

Setup

1. Enable Recyclarr in app selection
2. Go to Main Menu → Recyclarr Setup
3. Select desired quality profiles
4. Save configuration

Auto-Generated Config

easiarr generates recyclarr.yml based on your selections:

radarr:
  main:
    base_url: http://radarr:7878
    api_key: !env_var API_KEY_RADARR
    include:
      - template: radarr-quality-definition-movie
      - template: radarr-quality-profile-hd-bluray-web

📖 Recyclarr Documentation

---

Profilarr

TRaSH Guides profile sync (Web UI) - Visual interface for managing profiles.

Features

• 🌐 Web-based management UI
• 🔗 Direct *arr app connections
• 📊 Profile comparison view
• 🔄 One-click sync
• 📦 Supports Radarr and Sonarr

Configuration

Port: 6868
Config: /config

Setup

Profilarr is auto-configured during Full Auto Setup:

1. Authentication with global credentials
2. Automatic Radarr/Sonarr connection
3. API key saved to .env

Access

• URL: http://localhost:6868
• Username: Global username
• Password: Global password

Homepage Widget

widget:
  type: profilarr
  url: http://profilarr:6868
  key: ${API_KEY_PROFILARR}

📖 Profilarr on GitHub

---

Maintainerr

Automated media cleanup manager - Manages Plex library cleanup with rule-based automation.

Features

• 📚 Collection-based media management
• 🔧 Flexible rule system
• 🔗 Plex, Radarr, Sonarr, Overseerr, Tautulli integration
• 🗑️ Automated cleanup actions
• 📊 Web-based UI
• ⏰ Scheduled rule execution

Configuration

Port: 6246
Database: SQLite (embedded)

Setup

Maintainerr is auto-configured during Full Auto Setup:

1. API key generation
2. Automatic Plex connection (discovers servers from token)
3. Radarr and Sonarr connection configuration

Access

• URL: http://localhost:6246

Integrations

Maintainerr can connect to:

Service	Description
Plex	Media library to manage
Radarr	Movie removal actions
Sonarr	TV show removal actions
Overseerr	Request status integration
Tautulli	Viewing statistics for rules

Environment Variables

Variable	Description
API_KEY_MAINTAINERR	Maintainerr API key

Homepage Widget

widget:
  type: customapi
  url: http://maintainerr:6246/api/settings/version
  mappings:
    - field: version
      label: Version

📖 Maintainerr on GitHub

---

FileBot

Media file renaming and automation - Powerful media organizer.

Features

• ✏️ Intelligent file renaming
• 📂 Automatic organization
• 🎬 Metadata fetching
• 📝 Subtitle downloading
• 🔄 Batch processing

Configuration

Port: 5452
Data: /data
Content: /data (media directories)

Notes

FileBot is a commercial product - some features may require a license.

---

Chromium

Web browser container - Secure, isolated browsing.

Features

• 🌐 Full browser in container
• 🖥️ VNC/web-based access
• 🔒 Isolated from host
• 📁 Persistent profile

Configuration

Port: 3000
Config: /config

Use Cases

• Access internal-only web UIs securely
• Browse content requiring different location (with VPN)
• Isolated browsing environment

---

Guacamole

Clientless remote desktop gateway - Access remote desktops via web browser.

Features

• 🖥️ RDP, VNC, SSH support
• 🌐 Web-based access
• 🔐 Authentication
• 📋 Clipboard support
• 🖱️ Touch support

Dependencies

Requires Guacd (daemon) and PostgreSQL (database).

Configuration

Port: 8080
Database: PostgreSQL
Guacd: guacd:4822

Environment Variables

Variable	Description
POSTGRESQL_HOSTNAME	PostgreSQL host
POSTGRESQL_DATABASE	Database name
USERNAME_POSTGRESQL	Database username
PASSWORD_POSTGRESQL	Database password

---

DDNS-Updater

Dynamic DNS record updater - Keep DNS records updated with dynamic IP.

Features

• 🌐 Multiple provider support
• ⏰ Scheduled updates
• 📊 Web UI for status
• 🔔 Notifications

Configuration

Port: 8000
Data: /data

Supported Providers

• Cloudflare
• DuckDNS
• Google Domains
• Namecheap
• And many more...

Configuration File

Create config.json in the data directory:

{
  "settings": [
    {
      "provider": "cloudflare",
      "zone_identifier": "zone-id",
      "domain": "example.com",
      "host": "@",
      "ttl": 300,
      "token": "your-api-token"
    }
  ]
}

---

easiarr Utility Container

easiarr includes its own utility container for Homepage integration:

Features

• 📊 Exposes easiarr configuration to Homepage
• 🔖 Serves bookmark files (local and remote URLs)
• 📁 Static file server

Configuration

Port: 3010 (external) → 8080 (internal)
Config: ~/.config/easiarr/config.json
Bookmarks:
  - ~/.config/easiarr/bookmarks-local.html # Local URLs
  - ~/.config/easiarr/bookmarks-remote.html # Traefik URLs (if enabled)

Homepage Widget

Displays installed version in Homepage:

widget:
  type: customapi
  url: http://easiarr:8080/config.json
  mappings:
    - field: version
      label: Installed

---

🔗 Related

• Monitoring - System monitoring tools
• Infrastructure - Traefik, authentication
• Configuration - Configuration reference