Quick Start

This guide assumes you understand the basics of media automation, already run Radarr or Sonarr, and have Docker installed. If you’re new to any of them, start with the Radarr and Sonarr quick start guides, or Docker’s install guide.

Install Profilarr

Save this as compose.yml, then run docker compose up -d in the same folder:

services:
  profilarr:
    image: ghcr.io/dictionarry-hub/profilarr:latest
    container_name: profilarr
    restart: unless-stopped
    ports:
      - '6868:6868'
    volumes:
      - ./config:/config
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC

📖 More info: Docker·Installation

Create Your Account

Open Profilarr at http://localhost:6868. On a new install, the first visit goes to a setup page where you create the admin account: pick a username and a password of at least 8 characters. Profilarr signs you in once the account is created.

📖 More info: Authentication

Link a Database

Profilarr links the Dictionarry database on first start. Its card on the Databases page shows the repository it pulls from and how often Profilarr checks it for updates. Its quality profiles, custom formats, and the rest appear under their own sections in the sidebar. You can change anything it gives you, and your changes are kept when the database updates.

We maintain Dictionarry and think it’s a sensible default for everyone, but Profilarr doesn’t mind which configurations you use. You can link any other database alongside it, or instead of it, from the same page.

📖 More info: Databases·Local Changes

Connect an Arr Instance

Go to Arrs and add an instance. Give it a name, pick Radarr or Sonarr, then enter its URL and API key. Use Test Connection to check that Profilarr can reach it, then save.

📖 More info: Arr Instances

Sync Your Configurations

Open your instance under Arrs and go to its Sync tab. Work through its sections from top to bottom, each choosing part of what Profilarr sends to the Arr:

• Media Management: how files are named, the size limits for each quality, and other media settings.
• Delay Profiles: how long the Arr waits before grabbing a release, and whether it prefers Usenet or torrents.
• Quality Profiles: the profiles to sync. Each one brings along the custom formats it scores.

Each section has its own trigger. Manual syncs when you press Sync, Schedule syncs on a timetable, and On Pull syncs whenever the database pulls an update, so changes to Dictionarry reach your Arr on their own. Save your choices, then press Sync to send them now.

📖 More info: Sync

Assign Your Profile

Once the sync finishes, open Radarr’s Settings > Profiles and your synced quality profile is there, with its custom formats under Settings > Custom Formats.

Syncing doesn’t assign the profile to anything, so your library keeps the profiles it already had. To use the new one, edit a movie and pick it under Quality Profile, or select several movies from the Movies page and change them together. Sonarr works the same way, with series instead of movies.

Quality Profiles Custom Formats Movie

That’s It

Profilarr can look intimidating at first, with words like databases, syncs, and triggers thrown at you. But what you just did comes down to a few steps: you connected your Arr, picked the profiles you wanted from a database, told Profilarr when to sync, and put a profile to use. With On Pull, Dictionarry’s updates now reach your Arr on their own.

Everything else in Profilarr builds on what you’ve set up:

• Upgrades search for better releases of what you already have.
• Renames keep your files in line with your naming format.
• Drift tells you when an Arr no longer matches Profilarr.
• Cleanup removes what Profilarr no longer manages.
• Build and Test cover changing configurations and checking them against real releases.

For a walkthrough inside Profilarr itself, guided tours can be found under Settings > Onboarding.