diff --git a/images/docker-lidarr.md b/images/docker-lidarr.md index ec813215a..21dfe68e1 100755 --- a/images/docker-lidarr.md +++ b/images/docker-lidarr.md @@ -1,116 +1,147 @@ -[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/ +# [linuxserver/lidarr](https://github.com/linuxserver/docker-lidarr) +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lidarr.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-lidarr/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-lidarr/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/lidarr/latest/index.html) -[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png?v=4&s=4000)][linuxserverurl] +[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. +## Supported Architectures -## Contact information:- +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). -| 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] | +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: -The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :- +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | - + 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 +## Version Tags -# linuxserver/lidarr -[![](https://images.microbadger.com/badges/version/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/lidarr.svg)](https://microbadger.com/images/linuxserver/lidarr "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/lidarr.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-lidarr)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-lidarr/) +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. -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. - -[![lidarr](https://github.com/lidarr/Lidarr/blob/develop/Logo/400.png)][appurl] - -  +| Tag | Description | +| :----: | --- | +| latest | Stable Lidarr releases. | +| preview | Nightly Lidarr Releases. | ## Usage +Here are some example snippets to help you get started creating a container from this image. + +### 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. + +```yaml +--- +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. - +Docker 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. +### Ports (`-p`) | 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 | +| :----: | --- | +| `8686` | Application WebUI | + + +### Environment Variables (`-e`) + +| Env | Function | +| :----: | --- | +| `PUID=1001` | for UserID - see below for explanation | +| `PGID=1001` | for GroupID - see below for explanation | +| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/config` | Configuration files for Lidarr. | +| `/music` | Music files. | +| `/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) ``` -  +## Application Setup -## Setting up the application +Access the webui at `:8686`, for more information check out [Lidarr](https://github.com/lidarr/Lidarr). -`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]. -  +## Support Info -## 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` | - -  +* 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` ## 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.