Package: buildarr-radarr
Buildarr Radarr PluginThe Buildarr Radarr plugin (buildarr-radarr) is a plugin for Buildarr that adds the capability to configure and manageRadarrinstances.Radarr is a PVR application which downloads, renames and manages the lifecycle of movies in your media library. In other words, it is to movies whatSonarris to TV shoes. It can monitor for both upcoming and current releases and grab them when they become available, as well as upgrade to higher quality versions of monitored releases when a suitable version is available.Currently, Radarr V4 and Radarr V5 are the supported versions. If you are using Radarr V3 or earlier, please upgrade in order to manage your instances with Buildarr.InstallationWhen using Buildarr as astandalone application, the Radarr plugin can simply be installed usingpip:pipinstallbuildarrbuildarr-radarrWhen using Buildarr as aDocker container, the Radarr plugin is bundled with the official container (callum027/buildarr), so there is no need to install it separately.You can upgrade, or pin the version of the plugin to a specific version, within the container by setting the$BUILDARR_INSTALL_PACKAGESenvironment variable in thedocker runcommand using--env/-e:-eBUILDARR_INSTALL_PACKAGES="buildarr-radarr==<version>"Quick StartTo use the Radarr plugin, create aradarrblock withinbuildarr.yml, and enter the connection information required for the Buildarr instance to connect to the Radarr instance you'd like to manage.If authentication is disabled on your Radarr instance, Buildarr will automatically retrieve the API key from the instance, meaning that you do not need to define it in the configuration.If authentication is enabled, manually retrieve the API key for Radarr by copying it from Settings -> General -> Security -> API Key, and pasting it into the configuration file as shown below.---buildarr:watch_config:trueradarr:hostname:localhost# Defaults to `radarr`, or the instance name for instance-specific configs.port:7878# Defaults to 7878.protocol:http# Defaults to `http`.api_key:...# Required if authentication is enabled. Auto-fetch if authentication is disabled.Buildarr won't modify anything yet since no configuration has been defined, but you are able to test if Buildarr is able to connect to and authenticate with the Radarr instance.Try abuildarr run. If the output is similar to the below output, Buildarr was able to connect to your Radarr instance.2023-09-02 18:46:05,366 buildarr:1 buildarr.cli.run [INFO] Buildarr version 0.6.0 (log level: INFO)
2023-09-02 18:46:05,366 buildarr:1 buildarr.cli.run [INFO] Loading configuration file '/config/buildarr.yml'
2023-09-02 18:46:05,403 buildarr:1 buildarr.cli.run [INFO] Finished loading configuration file
2023-09-02 18:46:05,417 buildarr:1 buildarr.cli.run [INFO] Loaded plugins: radarr (0.1.0)
2023-09-02 18:46:05,417 buildarr:1 buildarr.cli.run [INFO] Loading instance configurations
2023-09-02 18:46:05,422 buildarr:1 buildarr.cli.run [INFO] Finished loading instance configurations
2023-09-02 18:46:05,422 buildarr:1 buildarr.cli.run [INFO] Running with plugins: radarr
2023-09-02 18:46:05,422 buildarr:1 buildarr.cli.run [INFO] Resolving instance dependencies
2023-09-02 18:46:05,422 buildarr:1 buildarr.cli.run [INFO] Finished resolving instance dependencies
2023-09-02 18:46:05,422 buildarr:1 buildarr.cli.run [INFO] Fetching TRaSH metadata
2023-09-02 18:46:09,856 buildarr:1 buildarr.cli.run [INFO] Finished fetching TRaSH metadata
2023-09-02 18:46:09,856 buildarr:1 buildarr.cli.run [INFO] Rendering instance configuration dynamic attributes
2023-09-02 18:46:09,856 buildarr:1 buildarr.cli.run [INFO] Finished rendering instance configuration dynamic attributes
2023-09-02 18:46:09,856 buildarr:1 buildarr.cli.run [INFO] Loading secrets file from '/config/secrets.json'
2023-09-02 18:46:09,857 buildarr:1 buildarr.cli.run [INFO] Finished loading secrets file
2023-09-02 18:46:09,857 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Checking secrets
2023-09-02 18:46:09,869 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Connection test successful using cached secrets
2023-09-02 18:46:09,869 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Finished checking secrets
2023-09-02 18:46:09,870 buildarr:1 buildarr.cli.run [INFO] Saving updated secrets file to '/config/secrets.json'
2023-09-02 18:46:09,871 buildarr:1 buildarr.cli.run [INFO] Finished saving updated secrets file
2023-09-02 18:46:09,871 buildarr:1 buildarr.cli.run [INFO] Performing post-initialisation configuration render
2023-09-02 18:46:10,092 buildarr:1 buildarr.cli.run [INFO] Finished performing post-initialisation configuration render
2023-09-02 18:46:10,092 buildarr:1 buildarr.cli.run [INFO] Updating configuration on remote instances
2023-09-02 18:46:10,092 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Fetching remote configuration to check if updates are required
2023-09-02 18:46:10,446 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Finished fetching remote configuration
2023-09-02 18:46:10,522 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Updating remote configuration
2023-09-02 18:46:10,840 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Remote configuration is up to date
2023-09-02 18:46:10,840 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Finished updating remote configuration
2023-09-02 18:46:10,840 buildarr:1 buildarr.cli.run [INFO] Finished updating configuration on remote instances
2023-09-02 18:46:10,840 buildarr:1 buildarr.cli.run [INFO] Deleting unmanaged/unused resources on remote instances
2023-09-02 18:46:10,840 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Refetching remote configuration to delete unused resources
2023-09-02 18:46:11,171 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Finished refetching remote configuration
2023-09-02 18:46:11,263 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Deleting unmanaged/unused resources on the remote instance
2023-09-02 18:46:11,442 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Remote configuration is clean
2023-09-02 18:46:11,442 buildarr:1 buildarr.cli.run [INFO] <radarr> (default) Finished deleting unmanaged/unused resources on the remote instance
2023-09-02 18:46:11,442 buildarr:1 buildarr.cli.run [INFO] Finished deleting unmanaged/unused resources on remote instances
2023-09-02 18:46:11,442 buildarr:1 buildarr.cli.run [INFO] Deleting downloaded TRaSH metadata
2023-09-02 18:46:11,461 buildarr:1 buildarr.cli.run [INFO] Finished deleting downloaded TRaSH metadataConfiguring your Buildarr instanceThe following sections cover comprehensive configuration of a Radarr instance.Note that these documents do not show how youshouldconfigure a Radarr instance. Rather, they show how youcanconfigure a Radarr instance the way you want with Buildarr. For more information on how to optimally configure Radarr, you can refer to the excellent guides fromWikiArrandTRaSH-Guides.Host ConfigurationSettingsMedia ManagementProfilesQuality ProfilesDelay ProfilesQualityCustom FormatsIndexersDownload ClientsNotifications (Connect)MetadataTagsGeneralUIConfiguration of the following resources are not yet supported by this plugin (but will be added in future versions):Import ListsIndexer Restrictions (Radarr V4 only)Release Profiles (Radarr V5+)Dumping an existing Radarr instance configurationBuildarr is capable of dumping a running Radarr instance's configuration.$ buildarr radarr dump-config http://localhost:7878 > radarr.yml
Radarr instance API key: <Paste API key here>The dumped YAML object can be placed directly under theradarrconfiguration block, or used as aninstance-specific configuration.All possible values are explicitly defined in this dumped configuration.hostname:localhostport:7878protocol:httpapi_key:1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4dimage:lscr.io/linuxserver/radarrversion:4.7.5.7809settings:media_management:rename_movies:truereplace_illegal_characters:truecolon_replacement:space-dash-spacestandard_movie_format:'{MovieCleanTitle}-{EditionTags}{[CustomFormats]}{[QualityFull]}{[MediaInfo3D]}{[MediaInfoVideoDynamicRangeType]}[{MediainfoAudioCodec}{MediainfoAudioChannels}]{[MediainfoVideoCodec]}{[ReleaseGroup]}-Default'movie_folder_format:'{MovieCleanTitle}({ReleaseYear})[imdbid-{ImdbId}]'create_missing_movie_folders:falsedelete_empty_folders:falseskip_free_space_check:falseminimum_free_space:100use_hardlinks:trueimport_using_script:falseimport_script_path:nullimport_extra_files:falseunmonitor_deleted_movies:falsepropers_and_repacks:do-not-preferanalyze_video_files:truerescan_folder_after_refresh:alwayschange_file_date:nonerecycling_bin:nullrecycling_bin_cleanup:28set_permissions:falsechmod_folder:drwxr-xr-xchown_group:nullroot_folders:delete_unmanaged:falsedefinitions:[]profiles:quality_profiles:delete_unmanaged:falsedefinitions:Movies:upgrades_allowed:truequalities:-Bluray-1080p-name:WEB 1080pmembers:-WEBRip-1080p-WEBDL-1080p-Bluray-720p-name:WEB 720pmembers:-WEBDL-720p-WEBRip-720p-Bluray-576p-Bluray-480p-name:WEB 480pmembers:-WEBDL-480p-WEBRip-480p-name:DVD-Videomembers:-DVD-R-DVDupgrade_until_quality:Bluray-1080pminimum_custom_format_score:0upgrade_until_custom_format_score:10000custom_formats:-name:4k-remasterscore:25-name:remasterscore:25language:Englishdelay_profiles:definitions:-preferred_protocol:torrent-preferusenet_delay:0torrent_delay:1440bypass_if_highest_quality:truetags:[]delete_unmanaged:falsequality:trash_id:nulldefinitions:Unknown:title:nullmin:0.0preferred:3.3max:nullWORKPRINT:title:nullmin:0.0preferred:95.0max:100.0CAM:title:nullmin:0.0preferred:95.0max:100.0TELESYNC:title:nullmin:0.0preferred:95.0max:100.0TELECINE:title:nullmin:0.0preferred:95.0max:100.0REGIONAL:title:nullmin:0.0preferred:95.0max:100.0DVDSCR:title:nullmin:0.0preferred:95.0max:100.0SDTV:title:nullmin:0.0preferred:95.0max:100.0DVD:title:nullmin:0.0preferred:95.0max:100.0DVD-R:title:nullmin:0.0preferred:95.0max:100.0WEBDL-480p:title:nullmin:0.0preferred:95.0max:100.0WEBRip-480p:title:nullmin:0.0preferred:95.0max:100.0Bluray-480p:title:nullmin:0.0preferred:95.0max:100.0Bluray-576p:title:nullmin:0.0preferred:95.0max:100.0HDTV-720p:title:nullmin:17.1preferred:95.0max:nullWEBDL-720p:title:nullmin:12.5preferred:95.0max:nullWEBRip-720p:title:nullmin:12.5preferred:95.0max:nullBluray-720p:title:nullmin:25.7preferred:95.0max:nullHDTV-1080p:title:nullmin:33.8preferred:95.0max:nullWEBDL-1080p:title:nullmin:12.5preferred:95.0max:nullWEBRip-1080p:title:nullmin:12.5preferred:95.0max:nullBluray-1080p:title:nullmin:50.8preferred:nullmax:nullRemux-1080p:title:nullmin:136.8preferred:nullmax:nullHDTV-2160p:title:nullmin:85.0preferred:nullmax:nullWEBDL-2160p:title:nullmin:34.5preferred:nullmax:nullWEBRip-2160p:title:nullmin:34.5preferred:nullmax:nullBluray-2160p:title:nullmin:102.0preferred:nullmax:nullRemux-2160p:title:nullmin:187.4preferred:nullmax:nullBR-DISK:title:nullmin:0.0preferred:nullmax:nullRaw-HD:title:nullmin:0.0preferred:nullmax:nullcustom_formats:delete_unmanaged:falsedefinitions:remaster:trash_id:nulldefault_score:nullinclude_when_renaming:falsedelete_unmanaged_conditions:falseconditions:Not 4K Remaster:negate:truerequired:truetype:release-titleregex:4KRemaster:negate:falserequired:truetype:release-titleregex:Remaster4k-remaster:trash_id:nulldefault_score:nullinclude_when_renaming:falsedelete_unmanaged_conditions:falseconditions:4K:negate:falserequired:truetype:release-titleregex:4kNot 4K Resolution:negate:truerequired:truetype:resolutionresolution:r2160pRemaster:negate:falserequired:truetype:release-titleregex:Remasterindexers:minimum_age:0retention:0maximum_size:0rss_sync_interval:60delete_unmanaged:falsedefinitions:1337x (Prowlarr):enable_rss:trueenable_automatic_search:trueenable_interactive_search:truepriority:25download_client:nulltags:[]minimum_seeders:2seed_ratio:nullseed_time:nulltype:torznabbase_url:http://prowlarr:9696/1/api_path:/apiapi_key:f6e5d4c3b2a10f6e5d4c3b2a10f6e5d4multi_languages:[]categories:-MOVIES-FOREIGN-MOVIES-SD-MOVIES-DVD-MOVIES-HDadditional_parameters:nulldownload_clients:delete_unmanaged:falsedefinitions:Transmission:enable:truepriority:1remove_completed:truetags:[]host:transmissionport:9091use_ssl:falseurl_base:/transmission/username:nullpassword:nullcategory:nulldirectory:/data/torrents/moviesrecent_priority:lastolder_priority:lastadd_paused:falsetype:transmissionnotifications:delete_unmanaged:falsedefinitions:{}metadata:certification_country:usemby_legacy:enable:falsemovie_metadata:truekodi_emby:enable:falsemovie_metadata:truemovie_metadata_url:falsemovie_metadata_language:englishmovie_images:trueuse_movie_nfo:falseadd_collection_name:trueroksbox:enable:falsemovie_metadata:truemovie_images:truewdtv:enable:falsemovie_metadata:truemovie_images:truetags:definitions:-supgeneral:host:bind_address:'*'port:7878ssl_port:9898use_ssl:falsessl_cert_path:nullssl_cert_password:nullurl_base:nullinstance_name:Radarrsecurity:authentication:noneusername:nullpassword:nullcertificate_validation:enabledproxy:enable:falseproxy_type:httphostname:nullport:8080username:nullpassword:nullignored_addresses:[]bypass_proxy_for_local_addresses:truelogging:log_level:INFOanalytics:send_anonymous_usage_data:falseupdates:branch:masterautomatic:falsemechanism:dockerscript_path:nullbackup:folder:Backupsinterval:7retention:28ui:first_day_of_week:mondayweek_column_header:day-firstruntime_format:hours-minutesshort_date_format:slash-day-firstlong_date_format:day-firsttime_format:twentyfour-hourshow_relative_dates:truetheme:autoenable_color_impaired_mode:falsemovie_info_language:englishui_language:english