Radarr#
Jellyseerr relies on Radarr for tracking, downloading and managing local copies of movies.
When a request is made for a movie, Jellyseerr will add it to Radarr.
Note
At the time of release, a Radarr plugin is not yet available for Buildarr.
Until one is released, an API key must be specified when adding a Radarr instance to Jellyseerr.
A common usage pattern is having multiple Radarr instances, one for non-4K movies and another for 4K movies:
jellyseerr:
settings:
sonarr:
delete_unmanaged: false
definitions:
"Radarr (HD)":
is_default_server: true
is_4k_server: false
hostname: "localhost"
port: 7878
use_ssl: false
api_key: "..."
root_folder: "/data/media/movies/hd"
quality_profile: "HD Movies"
minimum_availability: "released"
tags: []
enable_scan: false
enable_automatic_search: true
"Radarr (4K)":
is_default_server: true
is_4k_server: true
hostname: "localhost"
port: 7879
use_ssl: false
api_key: "..."
root_folder: "/data/media/movies/4k"
quality_profile: "4K Movies"
minimum_availability: "released"
tags: []
enable_scan: false
enable_automatic_search: true
For more information on configuring Radarr instances in Jellyseerr, refer to this guide in the Overseerr documentation.
delete_unmanaged: bool = False
class-attribute
instance-attribute
#
Automatically delete Radarr instance links not configured in Buildarr.
If unsure, leave set to the default value of false
.
definitions: Dict[str, Radarr] = {}
class-attribute
instance-attribute
#
Radarr service definitions are defined here.
Configuration#
The following configuration attributes are available when adding a Radarr instance to Jellyseerr.
is_default_server: bool = False
class-attribute
instance-attribute
#
Set this server as a default server for this application type.
Up to two default servers can be set at a time: one for non-4K content, one for 4K content.
is_4k_server: bool = False
class-attribute
instance-attribute
#
Use this server for managing 4K content.
instance_name: Optional[InstanceName] = Field(None, plugin='radarr')
class-attribute
instance-attribute
#
The name of the Radarr instance within Buildarr, if linking this Radarr instance with another Buildarr-defined Radarr instance.
hostname: NonEmptyStr
instance-attribute
#
The hostname that Jellyseerr will use to connect to the server.
port: Port = 7878
class-attribute
instance-attribute
#
The communication port that the Radarr server listens on.
use_ssl: bool = False
class-attribute
instance-attribute
#
Connect to the server using HTTPS.
api_key: Optional[ArrApiKey] = None
class-attribute
instance-attribute
#
API key for the Radarr server.
When not linking to a Buildarr-defined instance using instance_name
,
this attribute is required.
url_base: Optional[str] = None
class-attribute
instance-attribute
#
The URL base configured on the server, if it has one configured.
root_folder: NonEmptyStr
instance-attribute
#
Target root folder to use for movies in Radarr.
quality_profile: Union[NonEmptyStr, int]
instance-attribute
#
Quality profile to use for movies in Radarr.
minimum_availability: MinimumAvailability = MinimumAvailability.released
class-attribute
instance-attribute
#
The point of release at which requested movies are added to Radarr.
Values:
announced
in-cinemas
released
tags: Set[Union[NonEmptyStr, int]] = set()
class-attribute
instance-attribute
#
Tags to assign to movies in Radarr.
external_url: Optional[AnyHttpUrl] = None
class-attribute
instance-attribute
#
An optional external URL to the server, used to add clickable links to the servers on media detail pages.
If not defined, uses the internal URL to the instance.
enable_scan: bool = False
class-attribute
instance-attribute
#
Scan the server for existing media/request status.
It is recommended that this setting is enabled, so that users cannot submit requests for media which has already been requested or is already available.
enable_automatic_search: bool = True
class-attribute
instance-attribute
#
Automatically search for media upon approval of a request.