Skip to content
iongpt edited this page Sep 7, 2025 · 5 revisions

Welcome to Boxarr Wiki

Boxarr Logo

Automatically track and add trending box office movies to your Radarr library

License: GPL v3 Python 3.10+ Docker


🎬 What is Boxarr?

Boxarr is your automated bridge between the box office and your media library. It monitors weekly box office charts and seamlessly integrates trending movies into your Radarr instance, ensuring your collection always has what people want to watch.

Dashboard Overview

πŸš€ Quick Links

Getting Started

Core Features

Configuration

Advanced Topics

Help & Support

πŸ“Έ Visual Tour


Dashboard Overview

Weekly Box Office View

Initial Setup Wizard

Light Theme Dashboard

🌟 Key Features at a Glance

Feature Description
πŸ“Š Weekly Tracking Automatically fetches top 10 box office movies every week
🎯 Smart Matching Intelligently matches titles between Box Office Mojo and Radarr
⚑ Auto-Add Automatically adds trending movies with customizable filters
πŸ—‚οΈ Genre Folders Organize movies into different folders based on genre
πŸ“± Responsive UI Beautiful interface that works on all devices
πŸ”„ Quality Management Easy quality upgrades with one-click actions
πŸ“… Scheduled Updates Set it and forget it - runs on your schedule
πŸ”Œ REST API Full API for integration and automation

πŸ“‹ Prerequisites

Before installing Boxarr, ensure you have:

  • βœ… Radarr v3.0+ installed and configured
  • βœ… Docker (recommended) or Python 3.10+
  • βœ… Network access to Box Office Mojo
  • βœ… 100MB free disk space for application and data

🎯 Perfect For

  • 🏠 Home Media Servers - Keep your Plex/Jellyfin library current
  • πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Family Sharing - Automatically add what everyone wants to watch
  • 🎬 Movie Enthusiasts - Never miss a trending film
  • βš™οΈ Automation Lovers - Set it once, enjoy forever

πŸ“š Documentation Structure

This wiki is organized to help you find information quickly:

  • Installation & Setup - Get started from scratch
  • Features - Deep dive into each capability
  • Configuration - Customize every aspect
  • Advanced - Power user features
  • Support - Help when you need it

πŸ†˜ Need Help?

🚦 Getting Started

Ready to automate your movie library? Start here:

  1. Choose your installation method - Docker or manual
  2. Follow the setup wizard - Connect to Radarr
  3. Configure your preferences - Customize behavior
  4. Enjoy automated updates - Sit back and relax!

Made with ❀️ for the self-hosting community

Report Issue β€’ Request Feature β€’ Star on GitHub

Clone this wiki locally