From 326f87385398bfeb1c26da2a1e93e5c8e4322a03 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 1 Oct 2019 06:10:17 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-radarr.md | 42 ++++++++++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/images/docker-radarr.md b/images/docker-radarr.md index 78ef5c64f..c0c71cda8 100644 --- a/images/docker-radarr.md +++ b/images/docker-radarr.md @@ -1,9 +1,16 @@ -# linuxserver/radarr +# [linuxserver/radarr](https://github.com/linuxserver/docker-radarr) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-radarr.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-radarr/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/radarr) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/radarr) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/radarr) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/radarr) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-radarr.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-radarr/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/radarr "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/radarr "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/radarr) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/radarr) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/index.html) [Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato. + ## Supported Architectures 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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/). @@ -13,7 +20,7 @@ Simply pulling `linuxserver/radarr` should retrieve the correct image for your a The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | @@ -23,7 +30,7 @@ The architectures supported by this image are: 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 Radarr releases | | 5.14 | Stable Radarr releases, but run on Mono 5.14 | | nightly | Nightly Radarr releases | @@ -35,7 +42,7 @@ Here are some example snippets to help you get started creating a container from ### docker -```text +``` docker create \ --name=radarr \ -e PUID=1000 \ @@ -50,6 +57,7 @@ docker create \ linuxserver/radarr ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -77,40 +85,43 @@ services: ## Parameters -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. +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`\) +### Ports (`-p`) | Parameter | Function | -| :---: | :--- | +| :----: | --- | | `7878` | The port for the Radarr webinterface | -### Environment Variables \(`-e`\) + +### Environment Variables (`-e`) | Env | Function | -| :---: | :--- | +| :----: | --- | | `PUID=1000` | for UserID - see below for explanation | | `PGID=1000` | for GroupID - see below for explanation | | `TZ=Europe/London` | Specify a timezone to use EG Europe/London, this is required for Radarr | | `UMASK_SET=022` | control permissions of files and directories created by Radarr | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Database and Radarr configs | | `/movies` | Location of Movie library on disk | | `/downloads` | Location of download managers output directory | + + ## User / Group Identifiers -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 any permissions issues will vanish like magic. In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below: -```text +``` $ id username uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup) ``` @@ -119,6 +130,8 @@ 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). + + ## Support Info * Shell access whilst the container is running: @@ -143,4 +156,3 @@ Access the webui at `:7878`, for more information check out [Radarr](ht * **17.04.17:** - Switch to using inhouse mono baseimage, adds python also. * **13.04.17:** - Switch to official mono repository. * **10.01.17:** - Initial Release. -