diff --git a/README.md b/README.md index 9c5651f..d9e754b 100644 --- a/README.md +++ b/README.md @@ -61,9 +61,8 @@ This image provides various versions that are available via tags. `latest` tag u | Tag | Description | | :----: | --- | | latest | Stable Radarr releases | -| nightly | Nightly Radarr releases | -| preview | Preview Radarr releases, currently aphrodite | | 5.14 | Stable Radarr releases, but run on Mono 5.14 | +| nightly | Nightly Radarr releases | ## Usage @@ -79,9 +78,9 @@ docker create \ -e TZ=Europe/London \ -e UMASK_SET=022 `#optional` \ -p 7878:7878 \ - -v :/config \ - -v :/movies \ - -v :/downloads \ + -v /path/to/data:/config \ + -v /path/to/movies:/movies \ + -v /path/to/downloadclient-downloads:/downloads \ --restart unless-stopped \ linuxserver/radarr ``` @@ -104,9 +103,9 @@ services: - TZ=Europe/London - UMASK_SET=022 #optional volumes: - - :/config - - :/movies - - :/downloads + - /path/to/data:/config + - /path/to/movies:/movies + - /path/to/downloadclient-downloads:/downloads ports: - 7878:7878 restart: unless-stopped @@ -124,8 +123,8 @@ Container images are configured using parameters passed at runtime (such as thos | `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London, this is required for Radarr | | `-e UMASK_SET=022` | control permissions of files and directories created by Radarr | | `-v /config` | Database and Radarr configs | -| `-v /movies` | Location of Movie library on disk | -| `-v /downloads` | Location of download managers output directory | +| `-v /movies` | Location of Movie library on disk (See note in Application setup) | +| `-v /downloads` | Location of download managers output directory (See note in Application setup) | ## Environment variables from files (Docker secrets) @@ -163,6 +162,10 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel Access the webui at `:7878`, for more information check out [Radarr](https://github.com/Radarr/Radarr). +**Special Note**: Following our current folder structure will result in an inability to hardlink from your downloads to your movies folder because they are on seperate volumes. To support hardlinking, ensure that the movies and downloads data are on a single volume. For example, if you have `/mnt/storage/Movies` and `/mnt/storage/downloads/completed/Movies`, you would want something like `/mnt/storage:/media` for your volume. Then you can hardlink from `/media/downloads/completed` to `/media/Movies`. + +Another item to keep in mind, is that within Radarr itself, you should map your download client folder to your radarr folder. Navigate to **Settings -> Download Client -> Advanced Settings -> Remote Path Mappings**. Add a new mapping, and set: the Host as the same entry of the Host in your download client (for example its IP address), the Remote Path as `/downloads/Movies` (relative to the internal container path), and Local Path as `/media/downloads/completed/Movies`, assuming you have folders to separate your downloaded data types. + ## Docker Mods [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=mods&query=%24.mods%5B%27radarr%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=radarr "view available mods for this container.") @@ -235,6 +238,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64 ## Versions * **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. * **10.05.19:** - Rebase to Bionic. * **23.03.19:** - Switching to new Base images, shift to arm32v7 tag. diff --git a/readme-vars.yml b/readme-vars.yml index 9808122..2e730cc 100644 --- a/readme-vars.yml +++ b/readme-vars.yml @@ -18,17 +18,16 @@ available_architectures: development_versions: true development_versions_items: - { tag: "latest", desc: "Stable Radarr releases" } - - { tag: "nightly", desc: "Nightly Radarr releases" } - - { tag: "preview", desc: "Preview Radarr releases, currently aphrodite" } - { tag: "5.14", desc: "Stable Radarr releases, but run on Mono 5.14" } + - { tag: "nightly", desc: "Nightly Radarr releases" } # container parameters param_container_name: "{{ project_name }}" param_usage_include_vols: true param_volumes: - - { vol_path: "/config", vol_host_path: "", desc: "Database and Radarr configs" } - - { vol_path: "/movies", vol_host_path: "", desc: "Location of Movie library on disk" } - - { vol_path: "/downloads", vol_host_path: "", desc: "Location of download managers output directory" } + - { vol_path: "/config", vol_host_path: "/path/to/data", desc: "Database and Radarr configs" } + - { vol_path: "/movies", vol_host_path: "/path/to/movies", desc: "Location of Movie 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: @@ -46,9 +45,14 @@ app_setup_block_enabled: true app_setup_block: | Access the webui at `:7878`, for more information check out [Radarr](https://github.com/Radarr/Radarr). + **Special Note**: Following our current folder structure will result in an inability to hardlink from your downloads to your movies folder because they are on seperate volumes. To support hardlinking, ensure that the movies and downloads data are on a single volume. For example, if you have `/mnt/storage/Movies` and `/mnt/storage/downloads/completed/Movies`, you would want something like `/mnt/storage:/media` for your volume. Then you can hardlink from `/media/downloads/completed` to `/media/Movies`. + + Another item to keep in mind, is that within Radarr itself, you should map your download client folder to your radarr folder. Navigate to **Settings -> Download Client -> Advanced Settings -> Remote Path Mappings**. Add a new mapping, and set: the Host as the same entry of the Host in your download client (for example its IP address), the Remote Path as `/downloads/Movies` (relative to the internal container path), and Local Path as `/media/downloads/completed/Movies`, assuming you have folders to separate your downloaded data types. + # changelog changelogs: - { 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." }