Package: buildarr-prowlarr
Buildarr Prowlarr PluginThe Buildarr Prowlarr plugin (buildarr-prowlarr) is a plugin for Buildarr that adds the capability to configure and manageProwlarrinstances.Prowlarr is a manager/proxy for *Arr application Usenet and Torrent indexers. It handles communication with individual indexers for multiple instances on their behalf from a single client, allowing easier configuration of indexers by only setting them up once, and better management of traffic going to indexers to reduce the risk of running into rate limits.Prowlarr v1.0 and later are the only supported versions at this time. If you are using Prowlarr v0.4 or earlier, please upgrade in order to configure your instances with Buildarr.InstallationWhen using Buildarr as astandalone application, the Prowlarr plugin can simply be installed usingpip:$pipinstallbuildarrbuildarr-prowlarrIf you are linking a Prowlarr instance with another Buildarr-configured application, specify the following extras to also install a compatible version of the corresponding plugins:sonarr(for the Sonarr TV show PVR)radarr(for the Radarr movie PVR)$pipinstallbuildarrbuildarr-prowlarr[sonarr,radarr]When using Buildarr as aDocker container, the Prowlarr 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-prowlarr==<version>"Quick StartTo use the Prowlarr plugin, create aprowlarrblock withinbuildarr.yml, and enter the connection information required for the Buildarr instance to connect to the Prowlarr instance you'd like to manage.From version 1.0 onwards, Prowlarr enables authentication by default, preventing Buildarr from automatically retrieving the API key.If authentication is enabled on your Prowlarr configuration, manually retrieve the API key for Prowlarr by copying it from Settings -> General -> Security -> API Key, and pasting it into the configuration file as shown below.---buildarr:watch_config:trueprowlarr:hostname:"localhost"# Defaults to `prowlarr`, or the instance name for instance-specific configs.port:9696# Defaults to 9696.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 Prowlarr instance.Try abuildarr run. If the output is similar to the below output, Buildarr was able to connect to your Prowlarr instance.2023-03-29 20:39:50,856 buildarr:1 buildarr.cli.run [INFO] Buildarr version 0.4.0 (log level: INFO)
2023-03-29 20:39:50,856 buildarr:1 buildarr.cli.run [INFO] Loading configuration file '/config/buildarr.yml'
2023-03-29 20:39:50,872 buildarr:1 buildarr.cli.run [INFO] Finished loading configuration file
2023-03-29 20:39:50,874 buildarr:1 buildarr.cli.run [INFO] Loaded plugins: prowlarr (0.1.0)
2023-03-29 20:39:50,875 buildarr:1 buildarr.cli.run [INFO] Loading instance configurations
2023-03-29 20:39:50,877 buildarr:1 buildarr.cli.run [INFO] Finished loading instance configurations
2023-03-29 20:39:50,877 buildarr:1 buildarr.cli.run [INFO] Running with plugins: prowlarr
2023-03-29 20:39:50,877 buildarr:1 buildarr.cli.run [INFO] Resolving instance dependencies
2023-03-29 20:39:50,877 buildarr:1 buildarr.cli.run [INFO] Finished resolving instance dependencies
2023-03-29 20:39:50,877 buildarr:1 buildarr.cli.run [INFO] Loading secrets file from '/config/secrets.json'
2023-03-29 20:39:50,886 buildarr:1 buildarr.cli.run [INFO] Finished loading secrets file
2023-03-29 20:39:50,886 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Checking secrets
2023-03-29 20:39:50,912 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Connection test successful using cached secrets
2023-03-29 20:39:50,912 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Finished checking secrets
2023-03-29 20:39:50,912 buildarr:1 buildarr.cli.run [INFO] Saving updated secrets file to '/config/secrets.json'
2023-03-29 20:39:50,914 buildarr:1 buildarr.cli.run [INFO] Finished saving updated secrets file
2023-03-29 20:39:50,914 buildarr:1 buildarr.cli.run [INFO] Updating configuration on remote instances
2023-03-29 20:39:50,914 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Getting remote configuration
2023-03-29 20:39:51,406 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Finished getting remote configuration
2023-03-29 20:39:51,463 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Updating remote configuration
2023-03-29 20:39:52,019 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Remote configuration is up to date
2023-03-29 20:39:52,019 buildarr:1 buildarr.cli.run [INFO] <prowlarr> (default) Finished updating remote configuration
2023-03-29 20:39:52,019 buildarr:1 buildarr.cli.run [INFO] Finished updating configuration on remote instancesConfiguring your Buildarr instanceThe following sections cover comprehensive configuration of a Prowlarr instance.Note that these documents do not show how youshouldconfigure a Prowlarr instance. Rather, they show how youcanconfigure a Prowlarr instance the way you want with Buildarr. For more information on how to optimally configure Prowlarr, you can refer to the excellent guides fromWikiArrandTRaSH-Guides.Host ConfigurationSettingsIndexersIndexersProxiesAppsApplicationsSync ProfilesDownload ClientsNotificationsTagsGeneralUIDumping an existing Prowlarr instance configurationBuildarr is capable of dumping a running Prowlarr instance's configuration.$buildarrprowlarrdump-confighttp://localhost:9696>prowlarr.yml
ProwlarrinstanceAPIkey:<PasteAPIkeyhere>The dumped YAML object can be placed directly under theprowlarrconfiguration block, or used as aninstance-specific configuration.All possible values are explicitly defined in this dumped configuration.api_key:1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4dhostname:localhostimage:lscr.io/linuxserver/prowlarrport:9697protocol:httpsettings:apps:applications:definitions:Sonarr:anime_sync_categories:-tv/animeapi_key:1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4dbase_url:http://sonarr:8989instance_name:nullprowlarr_url:http://prowlarr:9696sync_categories:-tv/uhd-tv/other-tv/foreign-tv/sd-tv/web-dl-tv/hdsync_level:add-and-remove-onlytags:-testtype:sonarrdelete_unmanaged:falsesync_profiles:definitions:Standard:enable_automatic_search:trueenable_interactive_search:trueenable_rss:trueminimum_seeders:1delete_unmanaged:falsedownload_clients:definitions:{}delete_unmanaged:falsegeneral:analytics:send_anonymous_usage_data:truebackup:folder:Backupsinterval:7retention:28host:bind_address:'*'instance_name:Prowlarr (Buildarr Example)port:9696ssl_cert_password:nullssl_cert_path:nullssl_port:6969url_base:nulluse_ssl:falselogging:log_level:INFOproxy:bypass_proxy_for_local_addresses:trueenable:falsehostname:nullignored_addresses:[]password:nullport:8080proxy_type:httpusername:nullsecurity:authentication:formauthentication_required:local-disabledcertificate_validation:enabledpassword:mXkaCgbcm6LMVwSmj/aucXfRtYg18k7H+I4/6JPinSA=username:callumupdates:automatic:falsebranch:mastermechanism:dockerscript_path:nullindexers:indexers:definitions:1337x:enable:falsefields:baseUrl:nulldefinitionFile:1337xdownloadlink:iTorrents.orgdownloadlink2:magnetsort:createdtorrentBaseSettings.appMinimumSeeders:nulltorrentBaseSettings.packSeedTime:nulltorrentBaseSettings.seedRatio:nulltorrentBaseSettings.seedTime:nulltype:descgrab_limit:4priority:25query_limit:4redirect:falsesecret_fields:{}sync_profile:Standardtags:[]type:1337xNyaa.si:enable:falsefields:baseUrl:nullcat-id:All categoriesdefinitionFile:nyaasifilter-id:No filterprefer_magnet_links:truesort:createdtorrentBaseSettings.appMinimumSeeders:nulltorrentBaseSettings.packSeedTime:nulltorrentBaseSettings.seedRatio:nulltorrentBaseSettings.seedTime:nulltype:descgrab_limit:4priority:25query_limit:4redirect:falsesecret_fields:{}sync_profile:Standardtags:[]type:nyaasidelete_unmanaged:falseproxies:definitions:{}delete_unmanaged:falsenotifications:definitions:{}delete_unmanaged:falsetags:definitions:-testdelete_unused:falseui:enable_color_impaired_mode:falsefirst_day_of_week:sundaylong_date_format:month-firstshort_date_format:word-month-firstshow_relative_dates:truetheme:lighttime_format:twelve-hourui_language:enweek_column_header:month-firstversion:1.2.2.2699