معرفی شرکت ها
buildarr-prowlarr-0.2.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Prowlarr indexer manager plugin for Buildarr
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | buildarr-prowlarr-0.2.0 |
| نام | buildarr-prowlarr |
| نسخه کتابخانه | 0.2.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | Callum Dickinson |
| ایمیل نویسنده | callum.dickinson.nz@gmail.com |
| آدرس صفحه اصلی | https://buildarr.github.io/plugins/sonarr |
| آدرس اینترنتی | https://pypi.org/project/buildarr-prowlarr/ |
| مجوز | GPL-3.0-or-later |
# Buildarr Prowlarr Plugin
[](https://pypi.org/project/buildarr-prowlarr)  [](https://github.com/buildarr/buildarr-prowlarr/blob/main/LICENSE)  [](https://github.com/psf/black)
The Buildarr Prowlarr plugin (`buildarr-prowlarr`) is a plugin for Buildarr that adds the capability to configure and manage [Prowlarr](http://prowlarr.com) instances.
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.
## Installation
When using Buildarr as a [standalone application](https://buildarr.github.io/installation/#standalone-application), the Prowlarr plugin can simply be installed using `pip`:
```bash
$ pip install buildarr buildarr-prowlarr
```
If you are linking a Prowlarr instance with another Buildarr-configured Sonarr instance, use the `sonarr` extra to also install a compatible version of the Sonarr plugin.
```bash
$ pip install buildarr buildarr-prowlarr[sonarr]
```
When using Buildarr as a [Docker container](https://buildarr.github.io/installation/#docker), 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_PACKAGES` environment variable in the `docker run` command using `--env`/`-e`:
```bash
-e BUILDARR_INSTALL_PACKAGES="buildarr-prowlarr==<version>"
```
## Quick Start
To use the Prowlarr plugin, create a `prowlarr` block within `buildarr.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.
```yaml
---
buildarr:
watch_config: true
prowlarr:
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 a `buildarr run`. If the output is similar to the below output, Buildarr was able to connect to your Prowlarr instance.
```text
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 instances
```
## Configuring your Buildarr instance
The following sections cover comprehensive configuration of a Prowlarr instance.
Note that these documents do not show how you *should* configure a Prowlarr instance. Rather, they show how you *can* configure 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 from [WikiArr](https://wiki.servarr.com/prowlarr) and [TRaSH-Guides](https://trash-guides.info/Prowlarr/).
* [Host Configuration](https://buildarr.github.io/plugins/prowlarr/configuration/host)
* Settings
* Indexers
* [Indexers](https://buildarr.github.io/plugins/prowlarr/configuration/settings/indexers/indexers)
* [Proxies](https://buildarr.github.io/plugins/prowlarr/configuration/settings/indexers/proxies)
* Apps
* [Applications](https://buildarr.github.io/plugins/prowlarr/configuration/settings/apps/applications)
* [Sync Profiles](https://buildarr.github.io/plugins/prowlarr/configuration/settings/apps/sync-profiles)
* [Download Clients](https://buildarr.github.io/plugins/prowlarr/configuration/settings/download-clients)
* [Notifications](https://buildarr.github.io/plugins/prowlarr/configuration/settings/notifications)
* [Tags](https://buildarr.github.io/plugins/prowlarr/configuration/settings/tags)
* [General](https://buildarr.github.io/plugins/prowlarr/configuration/settings/general)
* [UI](https://buildarr.github.io/plugins/prowlarr/configuration/settings/ui)
## Dumping an existing Prowlarr instance configuration
Buildarr is capable of dumping a running Prowlarr instance's configuration.
```bash
$ buildarr prowlarr dump-config http://localhost:8989 > prowlarr.yml
Prowlarr instance API key: <Paste API key here>
```
The dumped YAML object can be placed directly under the `prowlarr` configuration block, or used as an [instance-specific configuration](https://buildarr.github.io/configuration/#multiple-instances-of-the-same-type).
All possible values are explicitly defined in this dumped configuration.
```yaml
api_key: 1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4d
hostname: localhost
image: lscr.io/linuxserver/prowlarr
port: 9697
protocol: http
settings:
apps:
applications:
definitions:
Sonarr:
anime_sync_categories:
- tv/anime
api_key: 1a2b3c4d5e6f1a2b3c4d5e6f1a2b3c4d
base_url: http://sonarr:8989
instance_name: null
prowlarr_url: http://prowlarr:9696
sync_categories:
- tv/uhd
- tv/other
- tv/foreign
- tv/sd
- tv/web-dl
- tv/hd
sync_level: add-and-remove-only
tags:
- test
type: sonarr
delete_unmanaged: false
sync_profiles:
definitions:
Standard:
enable_automatic_search: true
enable_interactive_search: true
enable_rss: true
minimum_seeders: 1
delete_unmanaged: false
download_clients:
definitions: {}
delete_unmanaged: false
general:
analytics:
send_anonymous_usage_data: true
backup:
folder: Backups
interval: 7
retention: 28
host:
bind_address: '*'
instance_name: Prowlarr (Buildarr Example)
port: 9696
ssl_cert_password: null
ssl_cert_path: null
ssl_port: 6969
url_base: null
use_ssl: false
logging:
log_level: INFO
proxy:
bypass_proxy_for_local_addresses: true
enable: false
hostname: null
ignored_addresses: []
password: null
port: 8080
proxy_type: http
username: null
security:
authentication: form
authentication_required: local-disabled
certificate_validation: enabled
password: mXkaCgbcm6LMVwSmj/aucXfRtYg18k7H+I4/6JPinSA=
username: callum
updates:
automatic: false
branch: master
mechanism: docker
script_path: null
indexers:
indexers:
definitions:
1337x:
enable: false
fields:
baseUrl: null
definitionFile: 1337x
downloadlink: iTorrents.org
downloadlink2: magnet
sort: created
torrentBaseSettings.appMinimumSeeders: null
torrentBaseSettings.packSeedTime: null
torrentBaseSettings.seedRatio: null
torrentBaseSettings.seedTime: null
type: desc
grab_limit: 4
priority: 25
query_limit: 4
redirect: false
secret_fields: {}
sync_profile: Standard
tags: []
type: 1337x
Nyaa.si:
enable: false
fields:
baseUrl: null
cat-id: All categories
definitionFile: nyaasi
filter-id: No filter
prefer_magnet_links: true
sort: created
torrentBaseSettings.appMinimumSeeders: null
torrentBaseSettings.packSeedTime: null
torrentBaseSettings.seedRatio: null
torrentBaseSettings.seedTime: null
type: desc
grab_limit: 4
priority: 25
query_limit: 4
redirect: false
secret_fields: {}
sync_profile: Standard
tags: []
type: nyaasi
delete_unmanaged: false
proxies:
definitions: {}
delete_unmanaged: false
notifications:
definitions: {}
delete_unmanaged: false
tags:
definitions:
- test
delete_unused: false
ui:
enable_color_impaired_mode: false
first_day_of_week: sunday
long_date_format: month-first
short_date_format: word-month-first
show_relative_dates: true
theme: light
time_format: twelve-hour
ui_language: en
week_column_header: month-first
version: 1.2.2.2699
```
نیازمندی
| مقدار | نام |
|---|---|
| >=0.3.2,<0.4.0 | prowlarr-py |
| >=0.5.0,<0.6.0 | buildarr |
| >=0.5.0 | buildarr-sonarr |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.8,<4.0 | Python |
نحوه نصب
نصب پکیج whl buildarr-prowlarr-0.2.0:
pip install buildarr-prowlarr-0.2.0.whl
نصب پکیج tar.gz buildarr-prowlarr-0.2.0:
pip install buildarr-prowlarr-0.2.0.tar.gz