Files
docker-radarr/README.md
T

153 lines
6.3 KiB
Markdown
Raw Normal View History

[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2017-01-10 20:14:27 +00:00
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
2017-01-10 20:14:27 +00:00
* 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
2017-01-10 20:14:27 +00:00
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!
2019-01-30 14:50:54 -05:00
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
2017-01-10 22:09:27 +00:00
# PSA: Changes are happening
2017-01-10 22:09:27 +00:00
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.
# [linuxserver/radarr](https://github.com/linuxserver/docker-radarr)
2019-01-30 14:50:54 -05:00
[![](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/radarr.svg)](https://microbadger.com/images/linuxserver/radarr "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/radarr.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg)
[Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato.
[![radarr](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/radarr.png)](https://github.com/Radarr/Radarr)
## Supported Architectures
2019-01-30 14:50:54 -05:00
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).
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
2019-01-30 14:50:54 -05:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
2017-01-10 22:09:27 +00:00
## Usage
Here are some example snippets to help you get started creating a container.
### docker
2017-01-10 22:09:27 +00:00
```
docker create \
--name=radarr \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 7878:7878 \
-v <path to data>:/config \
-v <path/to/movies>:/movies \
-v <path/to/downloadclient-downloads>:/downloads \
2019-01-30 14:50:54 -05:00
--restart unless-stopped \
2017-01-10 22:09:27 +00:00
linuxserver/radarr
```
You can choose between ,using tags, various branch versions of radarr, no tag is required to remain on the main branch.
2018-02-24 18:16:23 +00:00
Add one of the tags, if required, to the linuxserver/radarr line of the run/create command in the following format, linuxserver/radarr:nightly
2018-02-24 18:16:23 +00:00
The nightly branch and master branch can from time to time be the same version.
2018-02-24 17:54:01 +00:00
2018-02-24 18:16:23 +00:00
HOWEVER , USE THE NIGHTLY BRANCH AT YOUR OWN PERIL !!!!!!!!!
2018-02-24 17:54:01 +00:00
### docker-compose
2017-01-10 22:09:27 +00:00
Compatible with docker-compose v2 schemas.
2017-01-10 22:09:27 +00:00
```
---
version: "2"
services:
radarr:
image: linuxserver/radarr
container_name: radarr
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <path/to/movies>:/movies
- <path/to/downloadclient-downloads>:/downloads
ports:
- 7878:7878
mem_limit: 4096m
restart: unless-stopped
```
2017-01-10 22:09:27 +00:00
## Parameters
2017-01-10 22:09:27 +00:00
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` 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.
2017-01-10 22:09:27 +00:00
| Parameter | Function |
| :----: | --- |
| `-p 7878` | The port for the Radarr webinterface |
| `-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, this is required for Radarr |
| `-v /config` | Database and Radarr configs |
| `-v /movies` | Location of Movie library on disk |
| `-v /downloads` | Location of download managers output directory |
2017-04-17 12:05:22 +01:00
## User / Group Identifiers
2017-04-17 12:05:22 +01:00
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`.
2017-01-10 22:09:27 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2017-01-10 22:09:27 +00:00
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
2017-01-10 22:09:27 +00:00
```
$ id username
2017-01-10 22:09:27 +00:00
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
&nbsp;
## Application Setup
Access the webui at `<your-ip>:7878`, for more information check out [Radarr](https://github.com/Radarr/Radarr).
2017-01-10 22:09:27 +00:00
## Support Info
2017-01-10 22:09:27 +00:00
* Shell access whilst the container is running: `docker exec -it radarr /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f radarr`
* container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' radarr`
2017-01-10 22:09:27 +00:00
* image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/radarr`
2017-01-10 22:09:27 +00:00
## Versions
* **09.09.18:** - Add pipeline build process.
* **24.02.18:** - Add nightly branch.
* **06.02.18:** - Radarr repo changed owner.
* **15.12.17:** - Fix continuation lines.
* **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.