readme-vars.yml

---

# project information
project_name: lidarr
project_url: "https://github.com/lidarr/Lidarr"
project_logo: "https://github.com/lidarr/Lidarr/raw/develop/Logo/400.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) 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."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"

# supported architectures
available_architectures:
  - { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
  - { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "Stable Lidarr releases." }
  - { tag: "develop", desc: "Develop Lidarr Releases." }
  - { tag: "nightly", desc: "Nightly Lidarr Releases." }

# container parameters
common_param_env_vars_enabled: true #PGID, PUID, etc, you can set it to 'optional'
param_container_name: "{{ project_name }}"
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London." }
# optional env variables
opt_param_usage_include_env: false

param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/appdata/config", desc: "Configuration files for Lidarr." }
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/music", vol_host_path: "/path/to/music", desc: "Music files (See note in Application setup)." }
  - { vol_path: "/downloads", vol_host_path: "/path/to/downloads", desc: "Path to your download folder for music (See note in Application setup)." }
param_usage_include_ports: true
param_ports:
  - { external_port: "8686", internal_port: "8686", port_desc: "Application WebUI" }

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:8686`, for more information check out [Lidarr]({{ project_url }}).

  Special Note: Following our current folder structure will result in an inability to hardlink from your downloads to your Music folder because they are on seperate volumes. To support hardlinking, simply ensure that the Music and downloads data are on a single volume. For example, if you have /mnt/storage/Music and /mnt/storage/downloads/completed/Music, you would want something like /mnt/storage:/media for your volume. Then you can hardlink from /media/downloads/completed to /media/Music.

  Another item to keep in mind, is that within lidarr itself, you should then map your download client folder to your lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to seperate your downloaded data types.
  
  ### 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 dont understand, or dont want hardlinks/atomic moves.

  The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this.

# changelog
changelogs:
  - { date: "06.05.22:", desc: "Rebase master branch to Focal." }
  - { date: "06.05.22:", desc: "Rebase develop branch to Alpine." }
  - { date: "04.02.22:", desc: "Rebase nightly branch to Alpine, deprecate nightly-alpine branch." }
  - { date: "30.12.21:", desc: "Add nightly-alpine branch." }
  - { date: "01.08.21:", desc: "Add libchromaprint-tools." }
  - { date: "11.07.21:", desc: "Make the paths clearer to the user." }
  - { date: "18.04.21:", desc: "Switch `latest` tag to net core." }
  - { date: "25.01.21:", desc: "Publish `develop` tag." }
  - { date: "20.01.21:", desc: "Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information." }
  - { date: "18.04.20:", desc: "Removed /downloads and /music volumes from Dockerfiles." }
  - { date: "05.04.20:", desc: "Move app to /app." }
  - { date: "01.08.19:", desc: "Rebase to Linuxserver LTS mono version." }
  - { date: "13.06.19:", desc: "Add env variable for setting umask." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "08.03.19:", desc: "Rebase to Bionic, use proposed endpoint for libchromaprint." }
  - { date: "26.01.19:", desc: "Add pipeline logic and multi arch." }
  - { date: "22.04.18:", desc: "Switch to beta builds." }
  - { date: "17.03.18:", desc: "Add ENV XDG_CONFIG_HOME=\"/config/xdg\" to Dockerfile for signalr fix." }
  - { date: "27.02.18:", desc: "Use json to query for new version." }
  - { date: "23.02.18:", desc: "Initial Release." }