docker-documentation/images/docker-radarr.md

162 wiersze
6.8 KiB
Markdown
Czysty Zwykły widok Historia

2019-10-01 05:10:17 +00:00
# [linuxserver/radarr](https://github.com/linuxserver/docker-radarr)
2019-02-08 15:52:33 +00:00
2019-11-05 06:10:05 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-radarr.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-radarr)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-radarr.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-radarr/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-radarr/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-radarr/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/radarr)
2019-10-01 05:10:17 +00:00
[![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")
2019-11-05 06:10:05 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/radarr)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/radarr)
2019-10-01 05:10:17 +00:00
[![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)
2019-02-08 15:52:33 +00:00
[Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato.
2019-10-01 05:10:17 +00:00
2019-02-08 15:52:33 +00:00
## Supported Architectures
2019-09-03 05:10:41 +00: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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-08 15:52:33 +00:00
2019-02-12 06:10:10 +00:00
Simply pulling `linuxserver/radarr` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-08 15:52:33 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2019-10-01 05:10:17 +00:00
| :----: | --- |
2019-02-08 15:52:33 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 19:54:11 +00:00
| armhf | arm32v7-latest |
2019-02-08 15:52:33 +00:00
2019-05-05 16:42:10 +00:00
## 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 |
2019-10-01 05:10:17 +00:00
| :----: | --- |
2019-05-05 16:42:10 +00:00
| latest | Stable Radarr releases |
2019-05-19 15:41:33 +00:00
| 5.14 | Stable Radarr releases, but run on Mono 5.14 |
2019-06-05 19:44:52 +00:00
| nightly | Nightly Radarr releases |
| preview | Alpha Radarr releases, unsupported and for development only |
2019-04-02 05:10:04 +00:00
2019-02-08 15:52:33 +00:00
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2019-10-01 05:10:17 +00:00
```
2019-02-08 15:52:33 +00:00
docker create \
--name=radarr \
2019-03-05 06:09:46 +00:00
-e PUID=1000 \
-e PGID=1000 \
2019-02-08 15:52:33 +00:00
-e TZ=Europe/London \
2019-06-16 22:17:30 +00:00
-e UMASK_SET=022 `#optional` \
2019-02-08 15:52:33 +00:00
-p 7878:7878 \
-v <path to data>:/config \
-v <path/to/movies>:/movies \
-v <path/to/downloadclient-downloads>:/downloads \
--restart unless-stopped \
linuxserver/radarr
```
2019-10-01 05:10:17 +00:00
2019-02-08 15:52:33 +00:00
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
radarr:
image: linuxserver/radarr
container_name: radarr
environment:
2019-03-05 06:09:46 +00:00
- PUID=1000
- PGID=1000
2019-02-08 15:52:33 +00:00
- TZ=Europe/London
2019-06-16 22:17:30 +00:00
- UMASK_SET=022 #optional
2019-02-08 15:52:33 +00:00
volumes:
- <path to data>:/config
- <path/to/movies>:/movies
- <path/to/downloadclient-downloads>:/downloads
ports:
- 7878:7878
restart: unless-stopped
```
## Parameters
2019-10-01 05:10:17 +00:00
Docker 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.
2019-02-08 15:52:33 +00:00
2019-10-01 05:10:17 +00:00
### Ports (`-p`)
2019-02-08 15:52:33 +00:00
| Parameter | Function |
2019-10-01 05:10:17 +00:00
| :----: | --- |
2019-02-08 15:52:33 +00:00
| `7878` | The port for the Radarr webinterface |
2019-10-01 05:10:17 +00:00
### Environment Variables (`-e`)
2019-02-08 15:52:33 +00:00
| Env | Function |
2019-10-01 05:10:17 +00:00
| :----: | --- |
2019-03-05 06:09:46 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-08 15:52:33 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London, this is required for Radarr |
2019-06-16 22:17:30 +00:00
| `UMASK_SET=022` | control permissions of files and directories created by Radarr |
2019-02-08 15:52:33 +00:00
2019-10-01 05:10:17 +00:00
### Volume Mappings (`-v`)
2019-02-08 15:52:33 +00:00
| Volume | Function |
2019-10-01 05:10:17 +00:00
| :----: | --- |
2019-02-08 15:52:33 +00:00
| `/config` | Database and Radarr configs |
| `/movies` | Location of Movie library on disk |
| `/downloads` | Location of download managers output directory |
2019-10-01 05:10:17 +00:00
2019-02-08 15:52:33 +00:00
## User / Group Identifiers
2019-10-01 05:10:17 +00: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`.
2019-02-08 15:52:33 +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.
2019-03-05 06:09:46 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-08 15:52:33 +00:00
2019-10-01 05:10:17 +00:00
```
2019-02-08 15:52:33 +00:00
$ id username
2019-03-05 06:09:46 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-08 15:52:33 +00:00
```
## Application Setup
Access the webui at `<your-ip>:7878`, for more information check out [Radarr](https://github.com/Radarr/Radarr).
2019-10-01 05:10:17 +00:00
2019-02-08 15:52:33 +00:00
## Support Info
2019-09-03 05:10:41 +00:00
* Shell access whilst the container is running:
2019-02-08 15:52:33 +00:00
* `docker exec -it radarr /bin/bash`
2019-09-03 05:10:41 +00:00
* To monitor the logs of the container in realtime:
2019-02-08 15:52:33 +00:00
* `docker logs -f radarr`
2019-09-03 05:10:41 +00:00
* Container version number
2019-02-08 15:52:33 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' radarr`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/radarr`
## Versions
2019-08-03 20:10:11 +00:00
* **01.08.19:** - Rebase to Linuxserver LTS mono version.
2019-06-16 22:17:30 +00:00
* **13.06.19:** - Add env variable for setting umask.
2019-05-19 15:41:33 +00:00
* **10.05.19:** - Rebase to Bionic.
2019-03-24 19:54:11 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-08 15:52:33 +00:00
* **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.