profilarr

Build, test, and deploy configurations across your media stack

## Overview If you manage a media server, you've probably spent hours configuring quality profiles, piecing together custom formats from forum posts, and hoping nothing drifts between instances. Profilarr tries to make that easier. ## ✨ Features ### Build - **Link databases** - connect to curated databases like [Dictionarry](https://github.com/Dictionarry-Hub/database), [TRaSH Guides](https://github.com/Dictionarry-Hub/trash-pcd), or [Dumpstarr](https://github.com/Dumpstarr/Database) - **Build your own** - create and share your own database using the [PCD template](https://github.com/Dictionarry-Hub/database-template) - **Quality profiles** - group and order qualities, score custom formats per app - **Custom formats** - match releases by resolution, source, release group, size, language, and more - **Regular expressions** - reusable patterns shared across custom formats - **Media management** - naming conventions, media settings, and quality definitions - **Delay profiles** - protocol preferences, delays, and score gates - **Local tweaks** - your changes persist across upstream updates with smart conflict handling ### Test - **Regular expressions** - validate patterns with embedded [Regex101](https://regex101.com/) test cases - **Custom formats** - test releases against conditions with a full breakdown of how each passes or fails, with match visualization. Powered by a C# parser that matches Radarr and Sonarr's own parsing logic - **Quality profiles** - simulate how a profile scores and ranks releases for a given movie or series ### Deploy - **Sync** - push configurations to any number of Arr instances - **Upgrades** - automated searches with configurable filters, selectors, and cooldowns - **Rename** - bulk rename files and folders with dry-run previews - **Jobs** - scheduled automation for sync, upgrades, renames, backups, and cleanup - **Notifications** - Discord, Telegram, Slack, ntfy, Pushover, Gotify, Apprise, and generic webhooks ## Getting Started ### Requirements - Docker host with Linux kernel `3.17+`. Older kernels, including Synology DSM installs on kernel `3.10`, are not supported by Profilarr v2. - Docker platform `linux/amd64` or `linux/arm64` - Sonarr `v4+` - Radarr `v5+` ### Production ``` … ``` > [!NOTE] > The parser service is only required for custom format and quality profile > testing. Linking, syncing, and all other features work without it. Remove the > `parser` service and related environment variables if you don't need it. #### Release channels New features are tested on the `develop` image by beta testers first. Once a batch is verified, it becomes a stable release. Choose an image tag based on how you want to receive these releases: | Type | Tag | Description | | ------- | --------- | --------------------------------------------------------------------- | | Latest | `latest` | Newest stable release, including future major versions | | Develop | `develop` | Pre-release builds under testing; not guaranteed stable | | Exact | `2.1.0` | A specific release; never updates | | Major | `2` | Newest stable release within v2; never updates to a new major version | Both the `profilarr` and `profilarr-parser` images publish the same tags; keep them on the same channel. | Variable | Default | Description | | ------------------------ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | `PUID` | `1000` | User ID for file permissions | | `PGID` | `1000` | Group ID for file permissions | | `UMASK` | `022` | File creation mask | | `TZ` | `Etc/UTC` | Timezone for scheduling | | `PORT` | `6868` | Web UI port | | `HOST` | `0.0.0.0` | Bind address | | `AUTH` | `on` | Auth mode (`on`, `oidc`, `off`) | | `OIDC_CLIENT_SECRET` | - | OIDC client secret (when `AUTH=oidc`) | | `OIDC_CLIENT_ID` | - | OIDC client ID (when `AUTH=oidc`) | | `OIDC_DISCOVERY_URL` | - | OIDC discovery URL (when `AUTH=oidc`) | | `ORIGIN` | - | Public URL when running behind a reverse proxy (e.g. `https://profilarr.example.com`) | | `PARSER_HOST` | `localhost` | Parser service host | | `PARSER_PORT` | `5000` | Parser service port | | `PROFILARR_API_KEY` | - | Plaintext runtime secret for `X-Api-Key` auth | | `PROFILARR_BULLETIN_URL` | `https://raw.githubusercontent.com/Dictionarry-Hub/bulletin/main` | Override for the announcement feed + release manifest base URL | `PROFILARR_API_KEY` must be at least 32 characters long. It is not persisted to SQLite or bcrypt-hashed; while set, it overrides the stored database key. Removing it reactivates the stored database key if one exists. > [!NOTE] > When using OIDC `ORIGIN=` _must_ be set to your Profilarr URL, and Profilarr > expects `{ORIGIN}/auth/oidc/callback` for the redirect URL > (e.g. `https://profilarr.example.com/auth/oidc/callback`). Many > IdPs will infer this automatically. See the [documentation](https://dictionarry.dev/) for full setup and configuration guides. ### Development **Prerequisites** - [Git](https://git-scm.com/) (for PCD operations) - [Deno](https://deno.com/) 2.x - [.NET SDK](https://dotnet.microsoft.com/) 8.0+ (optional, for parser) ```bash git clone https://github.com/Dictionarry-Hub/profilarr.git cd profilarr deno task dev ``` This runs the parser service and Vite dev server concurrently. Contributions are welcome! For anything beyond small fixes, please open an issue or reach out on [Discord](https://discord.gg/2A89tXZMgA) first so we can discuss the approach. See [CONTRIBUTING.md](docs/CONTRIBUTING.md) for the full development workflow. ## ❤️ Support Every feature in Profilarr is free for everyone, and development will continue with or without donations. If you'd like to show support, you can, but it's in no way necessary. - :coffee: [Buy Me A Coffee](https://www.buymeacoffee.com/santiagosayshey) - :cat: [GitHub Sponsors](https://github.com/sponsors/Dictionarry-Hub) ## License [AGPL-3.0](LICENSE) Profilarr is free and open source. You do not need to pay anyone to use it. If someone is charging you for access to Profilarr, they are violating the spirit of this project.