readme-vars.yml

---

# project information
project_name: sonarr
project_url: "https://sonarr.tv/"
project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/sonarr-banner.png"
project_blurb: |
  [{{ project_name|capitalize }}]({{ project_url }}) (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.
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"}

# development version
development_versions: true
development_versions_items:
  - { tag: "latest", desc: "Stable releases from Sonarr (currently v3)" }
  - { tag: "develop", desc: "Development releases from Sonarr (currently v3)" }

# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Database and sonarr configs" }
  
opt_param_usage_include_vols: true
opt_param_volumes:
  - { vol_path: "/tv", vol_host_path: "/path/to/tvseries", desc: "Location of TV library on disk (See note in Application setup)" }
  - { vol_path: "/downloads", vol_host_path: "/path/to/downloadclient-downloads", desc: "Location of download managers output directory (See note in Application setup)" }

param_usage_include_ports: true
param_ports:
  - { external_port: "8989", internal_port: "8989", port_desc: "The port for the Sonarr webinterface" }
param_usage_include_env: true
param_env_vars:
  - { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London, this is required for Sonarr"}
# optional env variables
opt_param_usage_include_env: false

# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the webui at `<your-ip>:8989`, for more information check out [Sonarr](https://sonarr.tv/).

  ### 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](https://wiki.servarr.com/Docker_Guide#Consistent_and_well_planned_paths) on how to get started with this.


# changelog
changelogs:
  - { date: "03.08.22:", desc: "Deprecate armhf." }  
  - { date: "02.08.22:", desc: "Add armhf deprecation warning." }
  - { date: "28.04.22:", desc: "Rebase master branch to mono 6.12 base (focal)." }
  - { date: "20.02.22:", desc: "Rebase develop branch to Alpine, deprecate develop-alpine branch." }
  - { date: "28.12.21:", desc: "Add develop-alpine branch." }
  - { date: "11.05.21:", desc: "Make the paths clearer to the user." }
  - { date: "10.03.21:", desc: "Upgrade to Sonarr v3. Existing users are highly recommended to make a backup prior to update." }
  - { date: "18.01.21:", desc: "Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information." }
  - { 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: "10.05.19:", desc: "Rebase to Bionic." }
  - { date: "23.03.19:", desc: "Switching to new Base images, shift to arm32v7 tag." }
  - { date: "01.02.19:", desc: "Multi arch images and pipeline build logic" }
  - { date: "15.12.17:", desc: "Fix continuation lines." }
  - { date: "12.07.17:", desc: "Add inspect commands to README, move to jenkins build and push." }
  - { date: "17.04.17:", desc: "Switch to using inhouse mono baseimage, adds python also." }
  - { date: "14.04.17:", desc: "Change to mount /etc/localtime in README, thanks cbgj." }
  - { date: "13.04.17:", desc: "Switch to official mono repository." }
  - { date: "30.09.16:", desc: "Fix umask" }
  - { date: "23.09.16:", desc: "Add cd to /opt fixes redirects with althub (issue #25), make XDG config environment variable" }
  - { date: "15.09.16:", desc: "Add libcurl3 package." }
  - { date: "09.09.16:", desc: "Add layer badges to README." }
  - { date: "27.08.16:", desc: "Add badges to README." }
  - { date: "20.07.16:", desc: "Rebase to xenial." }
  - { date: "31.08.15:", desc: "Cleanup, changed sources to fetch binarys from. also a new baseimage." }