docker-documentation/images/docker-radarr.md

11 KiB

title
radarr

linuxserver/radarr

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Radarr - A fork of Sonarr to work with movies à la Couchpotato.

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/radarr:latest should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf arm32v7-<version tag>

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest Stable Radarr releases
develop Radarr releases from their develop branch
nightly Radarr releases from their nightly branch

Application Setup

Access the webui at <your-ip>:7878, for more information check out Radarr.

Media folders

We have set /movies and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.

Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.

The folks over at servarr.com wrote a good write-up on how to get started with this.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
version: "2.1"
services:
  radarr:
    image: lscr.io/linuxserver/radarr:latest
    container_name: radarr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/data:/config
      - /path/to/movies:/movies #optional
      - /path/to/downloadclient-downloads:/downloads #optional
    ports:
      - 7878:7878
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=radarr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 7878:7878 \
  -v /path/to/data:/config \
  -v /path/to/movies:/movies `#optional` \
  -v /path/to/downloadclient-downloads:/downloads `#optional` \
  --restart unless-stopped \
  lscr.io/linuxserver/radarr:latest

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function
7878 The port for the Radarr webinterface

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Database and Radarr configs
/movies Location of Movie library on disk (See note in Application setup)
/downloads Location of download managers output directory (See note in Application setup)

Miscellaneous Options

Parameter Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

Docker Mods Docker Universal Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it radarr /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f radarr
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' radarr
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/radarr:latest

Versions

  • 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
  • 06.06.22: - Rebase master branch to Alpine 3.15.
  • 20.02.22: - Rebase develop branch to Alpine.
  • 04.02.22: - Rebase nightly branch to Alpine and deprecate nightly-alpine branch.
  • 27.12.21: - Add nightly-alpine branch.
  • 17.10.21: - Remove UMASK_SET.
  • 08.05.21: - Make the paths clearer to the user
  • 17.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
  • 11.30.20: - Publish develop tag.
  • 11.28.20: - Switch to v3 .NET CORE builds (no more mono, 5.14 tag is deprecated). Rebase to Focal (for issues on arm32v7, see here).
  • 05.04.20: - Move app to /app.
  • 01.08.19: - Rebase to Linuxserver LTS mono version.
  • 13.06.19: - Add env variable for setting umask.
  • 10.05.19: - Rebase to Bionic.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 09.09.18: - Add pipeline build process.
  • 24.02.18: - Add nightly branch.
  • 06.02.18: - Radarr repo changed owner.
  • 15.12.17: - Fix continuation lines.
  • 17.04.17: - Switch to using inhouse mono baseimage, adds python also.
  • 13.04.17: - Switch to official mono repository.
  • 10.01.17: - Initial Release.