Search…
Images
Powered By GitBook
linuxserver/sonarr
Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. 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/sonarr 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
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest

Version Tags

This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag
Description
latest
Stable releases from Sonarr (currently v3)
develop
Development releases from Sonarr (currently v3)

Application Setup

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

Media folders

We have set /tv 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.
1
---
2
version: "2.1"
3
services:
4
sonarr:
5
image: lscr.io/linuxserver/sonarr
6
container_name: sonarr
7
environment:
8
- PUID=1000
9
- PGID=1000
10
- TZ=Europe/London
11
volumes:
12
- /path/to/data:/config
13
- /path/to/tvseries:/tv #optional
14
- /path/to/downloadclient-downloads:/downloads #optional
15
ports:
16
- 8989:8989
17
restart: unless-stopped
Copied!
1
docker run -d \
2
--name=sonarr \
3
-e PUID=1000 \
4
-e PGID=1000 \
5
-e TZ=Europe/London \
6
-p 8989:8989 \
7
-v /path/to/data:/config \
8
-v /path/to/tvseries:/tv `#optional` \
9
-v /path/to/downloadclient-downloads:/downloads `#optional` \
10
--restart unless-stopped \
11
lscr.io/linuxserver/sonarr
Copied!

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
8989
The port for the Sonarr webinterface

Environment Variables (-e)

Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=Europe/London
Specify a timezone to use EG Europe/London, this is required for Sonarr

Volume Mappings (-v)

Volume
Function
/config
Database and sonarr configs
/tv
Location of TV library on disk (See note in Application setup)
/downloads
Location of download managers output directory (See note in Application setup)
Miscellaneous Options

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
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:
1
$ id username
2
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!

Docker 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 sonarr /bin/bash
    To monitor the logs of the container in realtime:
      docker logs -f sonarr
    Container version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' sonarr
    Image version number
      docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sonarr

Versions

    11.05.21: - Make the paths clearer to the user.
    10.03.21: - Upgrade to Sonarr v3. Existing users are highly recommended to make a backup prior to update.
    18.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
    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.
    01.02.19: - Multi arch images and pipeline build logic
    15.12.17: - Fix continuation lines.
    12.07.17: - Add inspect commands to README, move to jenkins build and push.
    17.04.17: - Switch to using inhouse mono baseimage, adds python also.
    14.04.17: - Change to mount /etc/localtime in README, thanks cbgj.
    13.04.17: - Switch to official mono repository.
    30.09.16: - Fix umask
    23.09.16: - Add cd to /opt fixes redirects with althub (issue #25) , make XDG config environment variable
    15.09.16: - Add libcurl3 package.
    09.09.16: - Add layer badges to README.
    27.08.16: - Add badges to README.
    20.07.16: - Rebase to xenial.
    31.08.15: - Cleanup, changed sources to fetch binarys from. also a new baseimage.
Last modified 17d ago