Skip to content

Repository files navigation

Lidarr

Build Status Last Commit 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
Source https://github.com/Lidarr/Lidarr
Website https://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.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

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.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=lidarr
PUID=1000
PGID=1000
TZ=UTC

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  lidarr:
    name: lidarr
    options:
      - container: 'boot args:--pull'
      - expose: '8686:8686 proto:tcp'
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
    volumes:
      - lidarr: /config
      - music: /music
      - downloads: /downloads
volumes:
  lidarr:
    device: '/path/to/containers/lidarr'
  music:
    device: 'music'
  downloads:
    device: 'downloads'

Makejail:

# Makejail

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/lidarr:${tag}
SET allow.mlock=1

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

Note: 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 IPv4 address assigned by the virtual network.

Podman CLI

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.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -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

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

Note: 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 IPv4 address assigned by the virtual network.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah, shares the host network stack (inherit), and persists image-declared volumes under --data-path.

services:
  lidarr:
    image: "ghcr.io/daemonless/lidarr:latest"
    container_name: lidarr
    network_mode: host  # jail shares host networking
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=UTC

Save as podman-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --env PUID=1000 \
  --env PGID=1000 \
  --env TZ=UTC \
  --data-path /path/to/containers/lidarr \
  lidarr ghcr.io/daemonless/lidarr:latest inherit

Ansible

- 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.

Access at: http://localhost:8686

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

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

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

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages