📖Sportarr Documentation

Getting Started

Sportarr is an automated media management application for all sports. It works similar to Sonarr and Radarr but specifically designed for UFC, NFL, NBA, NHL, Premier League, Formula 1, and hundreds of other sports worldwide. Sportarr automatically:

  • Monitors sports leagues and teams like UFC, NFL, NBA, NHL, Premier League, Formula 1, and more
  • Tracks upcoming sporting events and downloads them when available
  • Organizes your sports library with metadata and artwork
  • Integrates with Usenet (SABnzbd) and torrent (qBittorrent, Transmission) clients
  • Connects to indexers to find sports content

✓Free & Open Source

Sportarr is completely free and open source. No subscriptions, no paywalls, just download and use!

Source Code

View the source code, report issues, or contribute on GitHub:

GitHub: Sportarr/Sportarr

Installation

⚠️Prerequisites

  • Download client: SABnzbd, qBittorrent, Transmission, or Deluge
  • Indexers: Usenet or torrent sources for sports content
  • Storage: Space for your sports media library

🐳 Docker Installation (Recommended)

The easiest way to run Sportarr is using Docker:

bash
docker run -d \
  --name=sportarr \
  -e PUID=99 \
  -e PGID=100 \
  -e UMASK=022 \
  -e TZ=America/New_York \
  -p 1867:1867 \
  -v /path/to/config:/config \
  -v /path/to/sports:/sports \
  -v /path/to/downloads:/downloads \
  --restart unless-stopped \
  sportarr/sportarr:latest

Or using Docker Compose:

yaml
version: "3.8"
services:
  sportarr:
    image: sportarr/sportarr:latest
    container_name: sportarr
    environment:
      - PUID=99
      - PGID=100
      - UMASK=022
      - TZ=America/New_York
    volumes:
      - /path/to/config:/config
      - /path/to/sports:/sports
      - /path/to/downloads:/downloads
    ports:
      - 1867:1867
    restart: unless-stopped

Environment Variables

PUIDDefault: 99

User ID for file permissions (run `id -u` to find yours)

PGIDDefault: 100

Group ID for file permissions (run `id -g` to find yours)

UMASKDefault: 022

File creation mask for permissions

TZDefault: UTC

Timezone for schedules (e.g., America/New_York, Europe/London)

💻 Manual Installation

Download pre-built binaries from GitHub releases:

  1. Go to GitHub Releases
  2. Download the version for your platform (Windows, Linux, macOS)
  3. Extract the archive to your desired location
  4. Run the Sportarr executable
  5. Access the web UI at http://localhost:1867

📦 Unraid Installation

Sportarr is available on Unraid Community Applications:

  1. Open Unraid Web UI
  2. Go to Apps tab
  3. Search for "Sportarr"
  4. Click Install
  5. Configure paths and click Apply

Configuration

⚙️ Initial Setup

After installation, access Sportarr at http://localhost:1867 and complete the setup wizard:

1. Set Root Folder

Choose where Sportarr will store your fight media. This should match your /fights volume.

Example: /fights or C:\Media\Fights

2. Add Download Client

Connect Sportarr to your download client. Supported clients:

  • SABnzbd - For Usenet downloads
  • qBittorrent - For torrent downloads
  • Transmission - For torrent downloads
  • Deluge - For torrent downloads

Settings → Download Clients → Add Client

3. Configure Indexers

Add your Usenet or torrent indexers to find combat sports content.

Settings → Indexers → Add Indexer

Note: You'll need indexers that support combat sports categories.

4. Connect to Metadata API

Point Sportarr to the metadata API for fight information:

https://sportarr.net/api

Settings → Metadata → API URL

No API key required! The metadata API is free and open.

5. Add Organizations

Start monitoring combat sports organizations:

  • UFC (Ultimate Fighting Championship)
  • Bellator MMA
  • ONE Championship
  • PFL (Professional Fighters League)
  • And many more!

Using Sportarr

📅 Adding Events

Once configured, Sportarr automatically discovers upcoming fight events:

  1. Go to Events to see all upcoming fights
  2. Browse by organization or use search
  3. Click Monitor on an event to track it
  4. Sportarr will automatically search for and download the event when available

🔍 Manual Search

You can manually search for specific events:

  1. Click on any monitored event
  2. Click Manual Search
  3. Review available releases
  4. Click Download on your preferred release

📚 Managing Your Library

Sportarr organizes your fight library automatically:

  • Organizations view - Browse by promotion
  • Events view - See all downloaded fights
  • Calendar - Track upcoming events
  • Activity - Monitor downloads and imports

Features

🤖Automatic Monitoring

Automatically tracks upcoming fight events from your favorite organizations and downloads them when available.

📊Rich Metadata

Fetches comprehensive fight information including fighter records, event posters, and fight cards.

🔄Quality Management

Set quality profiles and automatically upgrade to better releases when they become available.

📅Calendar View

View all upcoming fight events in an easy-to-read calendar format.

🔔Notifications

Get notified via Discord, Slack, Telegram, or email when events are downloaded.

🎨Beautiful UI

Modern, responsive web interface that works great on desktop and mobile devices.

🚀 Coming Soon

  • Advanced cache analytics and visualization
  • Custom cache warming strategies
  • Webhook delivery retry logic
  • GraphQL caching support
  • Multi-region cache distribution

Support & Community

Need help or want to contribute? Join the community!

Join Discord Server

Get help, share feedback, and connect with the community

🐛

Report Issues

Found a bug? Let us know on GitHub Issues

💬

Discussions

Ask questions and share ideas with the community

🤝

Contributing

Learn how to contribute to Sportarr