diff --git a/README.md b/README.md
index ec81321..a479cc9 100644
--- a/README.md
+++ b/README.md
@@ -1,116 +1,174 @@
-[linuxserverurl]: https://linuxserver.io
-[forumurl]: https://forum.linuxserver.io
-[ircurl]: https://www.linuxserver.io/irc/
-[podcasturl]: https://www.linuxserver.io/podcast/
-[appurl]: https://github.com/lidarr/Lidarr
-[hub]: https://hub.docker.com/r/linuxserver/lidarr/
+[](https://linuxserver.io)
+The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
-[][linuxserverurl]
+ * regular and timely application updates
+ * easy user mappings (PGID, PUID)
+ * custom base image with s6 overlay
+ * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
+ * regular security updates
+Find us at:
+* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
+* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
+* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
+* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
-## Contact information:-
+# PSA: Changes are happening
-| Type | Address/Details |
-| :---: | --- |
-| Discord | [Discord](https://discord.gg/YWrKVTn) |
-| Forum | [Linuserver.io forum][forumurl] |
-| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
-| Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! [Linuxserver.io Podcast][podcasturl] |
+From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
+TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
-The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
+# [linuxserver/lidarr](https://github.com/linuxserver/docker-lidarr)
+[](https://discord.gg/YWrKVTn)
+[](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")
+[](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")
+
+
+[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/)
+[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/index.html)
- + regular and timely application updates
- + easy user mappings
- + custom base image with s6 overlay
- + weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- + security updates
+[Lidarr](https://github.com/lidarr/Lidarr) 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.
-# linuxserver/lidarr
-[](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/lidarr "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-lidarr/)
+[](https://github.com/lidarr/Lidarr)
-Lidarr 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.
+## Supported Architectures
-[][appurl]
+Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
-
+Simply pulling `linuxserver/lidarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
+
+The architectures supported by this image are:
+
+| Architecture | Tag |
+| :----: | --- |
+| x86-64 | amd64-latest |
+| arm64 | arm64v8-latest |
+| armhf | arm32v6-latest |
+
+## Version Tags
+
+This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
+
+| Tag | Description |
+| :----: | --- |
+| latest | Stable Lidarr releases. |
+| preview | Nightly Lidarr Releases. |
## Usage
+Here are some example snippets to help you get started creating a container.
+
+### docker
+
```
docker create \
--name=lidarr \
- -v :/config \
- -v :/downloads \
- -v :/music \
- -e PGID= -e PUID= \
+ -e PUID=1001 \
+ -e PGID=1001 \
+ -e TZ=Europe/London \
-p 8686:8686 \
- lsiodev/lidarr-preview
+ -v :/config \
+ -v :/music \
+ -v :/downloads \
+ --restart unless-stopped \
+ linuxserver/lidarr
```
-
+
+### docker-compose
+
+Compatible with docker-compose v2 schemas.
+
+```
+---
+version: "2"
+services:
+ lidarr:
+ image: linuxserver/lidarr
+ container_name: lidarr
+ environment:
+ - PUID=1001
+ - PGID=1001
+ - TZ=Europe/London
+ volumes:
+ - :/config
+ - :/music
+ - :/downloads
+ ports:
+ - 8686:8686
+ mem_limit: 4096m
+ restart: unless-stopped
+```
## Parameters
-The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
-For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
-So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
-http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
-
-
+Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
| Parameter | Function |
-| :---: | --- |
-| `-p 8686` | the port(s) |
-| `-v /config` | Contains your config files|
-| `-v /downloads` | Path to your download folder for music |
-| `-v /music` | Path to your music library |
-| `-e PGID` | for GroupID, see below for explanation |
-| `-e PUID` | for UserID, see below for explanation |
-
-
+| :----: | --- |
+| `-p 8686` | Application WebUI |
+| `-e PUID=1001` | for UserID - see below for explanation |
+| `-e PGID=1001` | for GroupID - see below for explanation |
+| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
+| `-v /config` | Configuration files for Lidarr. |
+| `-v /music` | Music files. |
+| `-v /downloads` | Path to your download folder for music. |
## User / Group Identifiers
-Sometimes when using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
+When using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
-Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
+Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
```
- $ id
+ $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
-
-
-## Setting up the application
-
-`IMPORTANT: This is the dev preview version and is not meant for end users`
-
-Access the webui at `:8686`, for more information check out [Lidarr][appurl].
+## Application Setup
-## Container access and information.
+Access the webui at `:8686`, for more information check out [Lidarr](https://github.com/lidarr/Lidarr).
-| Function | Command |
-| :--- | :--- |
-| Shell access (live container) | `docker exec -it lidarr /bin/bash` |
-| Realtime container logs | `docker logs -f lidarr` |
-| Container version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' lidarr` |
-| Image version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lidarr` |
-
+
+## Support Info
+
+* Shell access whilst the container is running: `docker exec -it lidarr /bin/bash`
+* To monitor the logs of the container in realtime: `docker logs -f lidarr`
+* container version number
+ * `docker inspect -f '{{ index .Config.Labels "build_version" }}' lidarr`
+* image version number
+ * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lidarr`
+
+## Updating Info
+
+Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
+
+Below are the instructions for updating containers:
+
+### Via Docker Run/Create
+* Update the image: `docker pull linuxserver/lidarr`
+* Stop the running container: `docker stop lidarr`
+* Delete the container: `docker rm lidarr`
+* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
+* Start the new container: `docker start lidarr`
+* You can also remove the old dangling images: `docker image prune`
+
+### Via Docker Compose
+* Update the image: `docker-compose pull linuxserver/lidarr`
+* Let compose update containers as necessary: `docker-compose up -d`
+* You can also remove the old dangling images: `docker image prune`
## Versions
-| Date | Changes |
-| :---: | --- |
-| 26.01.19 | Add pipeline logic and multi arch, switching to tagged release from auto updates |
-| 22.04.18 | Switch this branch to the nightly versions, auto-updating on container start |
-| 17.03.18 | Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix. |
-| 27.02.18 | Use json to query for new version. |
-| 23.02.18 | Initial Release. |
+* **26.01.19:** - Add pipeline logic and multi arch.
+* **22.04.18:** - Switch to beta builds.
+* **17.03.18:** - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
+* **27.02.18:** - Use json to query for new version.
+* **23.02.18:** - Initial Release.
diff --git a/readme-vars.yml b/readme-vars.yml
index 122c6c5..69aa06e 100644
--- a/readme-vars.yml
+++ b/readme-vars.yml
@@ -2,122 +2,47 @@
# project information
project_name: lidarr
-full_custom_readme: |
- {% raw -%}
- [linuxserverurl]: https://linuxserver.io
- [forumurl]: https://forum.linuxserver.io
- [ircurl]: https://www.linuxserver.io/irc/
- [podcasturl]: https://www.linuxserver.io/podcast/
- [appurl]: https://github.com/lidarr/Lidarr
- [hub]: https://hub.docker.com/r/linuxserver/lidarr/
+project_url: "https://github.com/lidarr/Lidarr"
+project_logo: "https://github.com/lidarr/Lidarr/blob/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: "arm32v6-latest"}
- [][linuxserverurl]
+# development version
+development_versions: true
+development_versions_items:
+ - { tag: "latest", desc: "Stable Lidarr releases." }
+ - { tag: "preview", 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." }
+param_usage_include_vols: true
+param_volumes:
+ - { vol_path: "/config", vol_host_path: "", desc: "Configuration files for Lidarr." }
+ - { vol_path: "/music", vol_host_path: "", desc: "Music files." }
+ - { vol_path: "/downloads", vol_host_path: "", desc: "Path to your download folder for music." }
+param_usage_include_ports: true
+param_ports:
+ - { external_port: "8686", internal_port: "8686", port_desc: "Application WebUI" }
- ## Contact information:-
+# application setup block
+app_setup_block_enabled: true
+app_setup_block: |
+ Access the webui at `:8686`, for more information check out [Lidarr]({{ project_url }}).
- | Type | Address/Details |
- | :---: | --- |
- | Discord | [Discord](https://discord.gg/YWrKVTn) |
- | Forum | [Linuserver.io forum][forumurl] |
- | IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
- | Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! [Linuxserver.io Podcast][podcasturl] |
-
-
- The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
-
- + regular and timely application updates
- + easy user mappings
- + custom base image with s6 overlay
- + weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- + security updates
-
- # linuxserver/lidarr
- [](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/lidarr "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-lidarr/)
-
- Lidarr 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.
-
- [][appurl]
-
-
-
- ## Usage
-
- ```
- docker create \
- --name=lidarr \
- -v :/config \
- -v :/downloads \
- -v :/music \
- -e PGID= -e PUID= \
- -p 8686:8686 \
- lsiodev/lidarr-preview
- ```
-
-
-
- ## Parameters
-
- The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
- For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
- So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
- http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
-
-
-
- | Parameter | Function |
- | :---: | --- |
- | `-p 8686` | the port(s) |
- | `-v /config` | Contains your config files|
- | `-v /downloads` | Path to your download folder for music |
- | `-v /music` | Path to your music library |
- | `-e PGID` | for GroupID, see below for explanation |
- | `-e PUID` | for UserID, see below for explanation |
-
-
-
- ## User / Group Identifiers
-
- Sometimes when using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
-
- Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
-
- In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
-
- ```
- $ id
- uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
- ```
-
-
-
- ## Setting up the application
-
- `IMPORTANT: This is the dev preview version and is not meant for end users`
-
- Access the webui at `:8686`, for more information check out [Lidarr][appurl].
-
-
-
- ## Container access and information.
-
- | Function | Command |
- | :--- | :--- |
- | Shell access (live container) | `docker exec -it lidarr /bin/bash` |
- | Realtime container logs | `docker logs -f lidarr` |
- | Container version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' lidarr` |
- | Image version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/lidarr` |
-
-
-
- ## Versions
-
- | Date | Changes |
- | :---: | --- |
- | 26.01.19 | Add pipeline logic and multi arch, switching to tagged release from auto updates |
- | 22.04.18 | Switch this branch to the nightly versions, auto-updating on container start |
- | 17.03.18 | Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix. |
- | 27.02.18 | Use json to query for new version. |
- | 23.02.18 | Initial Release. |
- {%- endraw %}
+# changelog
+changelogs:
+ - { 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." }