Portainer Templates logo

Portainer Templates

Lidarr Lidarr

Container

Media ManagementMusic

Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists 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.

Image details

Pulls: 568.0M
Architecture: amd64, arm64
Image size: 118 MB
Latest: 3.1.3-develop
User: linuxserver
Created: Jan 09, 2018
Updated: 1 day ago
Status: active

Source details

Stars: 6k
Forks: 387
Language: C#
License: GPL-3.0
Updated: 1 day ago

Configuration

Type
Container
Platform
linux
Image
linuxserver/lidarr:latest
Ports
8686:8686/tcp
Volumes
/config : /srv/lsio/lidarr/config/music : /srv/lsio/lidarr/music/downloads : /srv/lsio/lidarr/downloads
Env vars
PUID=1000PGID=1000TZ=Etc/UTC
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/lidarr/config
mkdir -p /srv/lsio/lidarr/music
mkdir -p /srv/lsio/lidarr/downloads

Standalone Install

Select an install method, to see config/commands for deploying Lidarr

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Lidarr, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation, or see lidarr/Lidarr for app-specific guidance.

linuxserver.io
Blog Discord Discourse GitHub Open Collective
The LinuxServer.io team brings you another container release featuring:
  • regular and timely application updates
  • easy user mappings (PGID, PUID)
  • custom base image with s6 overlay
  • weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
  • regular security updates

Find us at:
  • Blog - all the things you can do with our containers including How-To guides, opinions and much more!
  • Discord - realtime support / chat with the community and the team.
  • Discourse - post on our community forum.
  • GitHub - view the source for all of our repositories.
  • Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/lidarr

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists 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.
lidarr

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/lidarr: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:
ArchitectureAvailableTag
x86-64amd64-\
arm64arm64v8-\

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.
TagAvailableDescription
latestStable Lidarr releases.
developDevelop Lidarr Releases.
nightlyNightly Lidarr Releases.

Application Setup

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

Media folders

We have set /music 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 don't understand, or don't want hardlinks/atomic moves.
Well planned paths
The folks over at servarr.com wrote a good write-up on how to get started with this.

Read-Only Operation

This image can be run with a read-only container filesystem. For details please read the docs.

Non-Root Operation

This image can be run with a non-root user. For details please read the docs.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  lidarr:
    image: lscr.io/linuxserver/lidarr:latest
    container_name: lidarr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/lidarr/config:/config
      - /path/to/music:/music #optional
      - /path/to/downloads:/downloads #optional
    ports:
      - 8686:8686
    restart: unless-stopped

docker cli (click here for more info)

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

Parameters

Containers 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.
ParameterFunction
-p 8686:8686Application WebUI
-e PUID=1000for UserID - see below for explanation
-e PGID=1000for GroupID - see below for explanation
-e TZ=Etc/UTCspecify a timezone to use, see this list.
-v /configConfiguration files for Lidarr.
-v /musicMusic files (See note in Application setup).
-v /downloadsPath to your download folder for music (See note in Application setup).
--read-only=trueRun container with a read-only filesystem. Please read the docs.
--user=1000:1000Run container with a non-root user. Please read the docs.

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 your_user as below:
id your_user

Example output:
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

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

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

  • Update images:
* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull lidarr
    ```
  • Update containers:
* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d lidarr
    ```
  • You can also remove the old dangling images:
```bash
docker image prune
```

Via Docker Run

  • Update the image:
```bash
docker pull lscr.io/linuxserver/lidarr:latest
```
  • Stop the running container:
```bash
docker stop lidarr
```
  • Delete the container:
```bash
docker rm lidarr
```
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
  • You can also remove the old dangling images:
```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/linuxserver/docker-lidarr.git
cd docker-lidarr
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/lidarr:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 04.07.26: - Rebase to Alpine 3.24.
  • 15.01.26: - Rebase to Alpine 3.23.
  • 05.07.25: - Rebase to Alpine 3.22.
  • 23.12.24: - Rebase to Alpine 3.21.
  • 31.05.24: - Rebase to Alpine 3.20.
  • 20.03.24: - Rebase to Alpine 3.19.
  • 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
  • 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
  • 06.06.22: - Rebase master branch to Alpine 3.15.
  • 06.05.22: - Rebase master branch to Focal.
  • 06.05.22: - Rebase develop branch to Alpine.
  • 04.02.22: - Rebase nightly branch to Alpine, deprecate nightly-alpine branch.
  • 30.12.21: - Add nightly-alpine branch.
  • 01.08.21: - Add libchromaprint-tools.
  • 11.07.21: - Make the paths clearer to the user.
  • 18.04.21: - Switch latest tag to net core.
  • 25.01.21: - Publish develop tag.
  • 20.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.
  • 18.04.20: - Removed /downloads and /music volumes from Dockerfiles.
  • 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.
  • 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
  • 08.03.19: - Rebase to Bionic, use proposed endpoint for libchromaprint.
  • 26.01.19: - Add pipeline logic and multi arch.
  • 22.04.18: - Switch to beta builds.
  • 17.03.18: - Add ENV XDGCONFIGHOME="/config/xdg" to Dockerfile for signalr fix.
  • 27.02.18: - Use json to query for new version.
  • 23.02.18: - Initial Release.

Serve Lidarr on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying lidarr.example.com to http://Lidarr:8686

Add this to your Caddyfile

lidarr.example.com {
	reverse_proxy http://Lidarr:8686
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Lidarr
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8686 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8686
  • Stop the other service, or pick a different host port. In 8686:8686 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8686. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Lidarr can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8686

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/lidarr/config (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/lidarr:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Lidarr --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Lidarr runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Lidarr needs bundled into one download. This template pulls linuxserver/lidarr:latest, which Docker fetches once (about 118 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Lidarr's comes from Docker Hub, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 3.1.3-develop. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 8686:8686 means it's reachable on port 8686 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 8686:8686

Volumes

A volume is where Lidarr keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /srv/lsio/lidarr/config on the host
  • /music from /srv/lsio/lidarr/music on the host
  • /downloads from /srv/lsio/lidarr/downloads on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Lidarr takes 3 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the UID to use here.
  • PGID, defaults to 1000. Run 'id [USER]' for the owner of the host volume directories to get the GID to use here.
  • TZ, defaults to Etc/UTC. Specify a timezone to use, see this list.

Restart policy

The restart policy here is unless-stopped, so Docker restarts Lidarr after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Lidarr sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container Lidarr. That's what you'll spot in the containers list and use in commands like docker logs Lidarr.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Lidarr is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Lidarr up. Add the template list to Portainer once, then deploying Lidarr is a click rather than a wall of config.