Skip to content

Lidarr Lidarr

Description / nameInput element
Container Registry
Container Configuration Root Path
Global /downloads Path
Global /music Path
Timezone
User ID
Group ID
Lidarr Host Port
Lidarr /config Path

Build Status Last Commit OCI Pulls mlock Required

Music collection manager for Usenet and BitTorrent users — monitors RSS feeds, grabs, sorts, and renames tracks from your favorite artists.

Port 8686
Registry ghcr.io/daemonless/lidarr
Daemonless daemonless/lidarr
Source Lidarr/Lidarr
Website lidarr.audio

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users — recommended.
develop Develop branch — Servarr's recommended pre-release channel; includes plugin support (/system/plugins) and is more tested than nightly. One-way DB migrations; back up /config before switching back to release. Alternative build.
nightly Nightly branch — bleeding-edge; also has plugin support (/system/plugins). One-way DB migrations; back up /config before switching back to release. Alternative build.
pkg FreeBSD Quarterly. Uses stable, tested packages. Production stability.
pkg-latest FreeBSD Latest. Rolling package updates. Staying current.

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions, including the security model for host vs. container privileges.

Deployment

services:
  lidarr:
    image: "ghcr.io/daemonless/lidarr:latest"
    container_name: lidarr
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
    volumes:
      - "/path/to/containers/lidarr:/config"
      - "/path/to/music:/music" # optional
      - "/path/to/downloads:/downloads" # optional
    ports:
      - "8686:8686"
    annotations:
      org.freebsd.jail.allow.mlock: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

podman run -d --name lidarr \
  -p 8686:8686 \
  --annotation 'org.freebsd.jail.allow.mlock=true' \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -v /path/to/containers/lidarr:/config \
  -v /path/to/music:/music # optional \
  -v /path/to/downloads:/downloads # optional \
  ghcr.io/daemonless/lidarr:latest

Save as run.sh, then run sh run.sh.

- name: Deploy lidarr
  containers.podman.podman_container:
    name: lidarr
    image: "ghcr.io/daemonless/lidarr:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
    ports:
      - "8686:8686"
    volumes:
      - "/path/to/containers/lidarr:/config"
      - "/path/to/music:/music" # optional
      - "/path/to/downloads:/downloads" # optional
    annotation:
      org.freebsd.jail.allow.mlock: "true"

Save as lidarr-deploy.yaml, then run ansible-playbook lidarr-deploy.yaml.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

1
2
3
4
5
6
# .env

DIRECTOR_PROJECT=lidarr
PUID=1000
PGID=1000
TZ=UTC
# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  lidarr:
    name: lidarr
    options:
      - container: 'args:--pull'
      - expose: '8686:8686 proto:tcp'
      - template: !ENV '${PWD}/template.conf'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - LIDARR_CONFIG_PATH: /config
      - MUSIC_PATH: /music
      - DOWNLOADS_PATH: /downloads
volumes:
  LIDARR_CONFIG_PATH:
    device: '/path/to/containers/lidarr'
  MUSIC_PATH:
    device: '/path/to/music'
  DOWNLOADS_PATH:
    device: '/path/to/downloads'
1
2
3
4
5
6
7
# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/lidarr:${tag}
1
2
3
4
5
6
7
# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.mlock

Save the files above, then run appjail-director up.

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o template=template.conf \
  -o expose="8686:8686 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -o fstab="/path/to/containers/lidarr /config <pseudofs>" \
  -o fstab="/path/to/music /music <pseudofs>" \ # optional
  -o fstab="/path/to/downloads /downloads <pseudofs>" \ # optional
  ghcr.io/daemonless/lidarr:latest lidarr

template.conf:

1
2
3
4
5
6
7
# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.mlock

Save the files above, then run sh run.sh.

Experimental

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  lidarr:
    name: lidarr
    image: "ghcr.io/daemonless/lidarr:latest"
    network:
      - mode: host
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC
    volumes:
      - "/path/to/containers/lidarr:/config"
      - "/path/to/music:/music"
      - "/path/to/downloads:/downloads"

Save as bastille-compose.yml, then run bastille up.

1
2
3
4
5
6
7
8
bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --volume /path/to/containers/lidarr /config \
  --volume /path/to/music /music \
  --volume /path/to/downloads /downloads \
  lidarr ghcr.io/daemonless/lidarr:latest inherit

Access at: http://localhost:8686

Interactive Configuration

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container

Volumes

Path Description
/config Configuration directory
/music Music library (Optional)
/downloads Download directory (Optional)

Ports

Port Protocol Description
8686 TCP Web UI

Implementation Details

  • Architectures: amd64
  • User: bsd (UID/GID set via PUID/PGID). Defaults to 1000:1000.
  • Base: Built on ghcr.io/daemonless/base (FreeBSD 15.1).
  • mlock: Requires --annotation 'org.freebsd.jail.allow.mlock=true' (ocijail 0.5.0+)

Need help? Join our Discord community.