docker-documentation/images/docker-radarr.md

188 wiersze
9.9 KiB
Markdown
Czysty Zwykły widok Historia

2020-06-30 05:09:52 +00:00
# [linuxserver/radarr](https://github.com/linuxserver/docker-radarr)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-radarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-radarr)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-radarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-radarr/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-radarr/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-radarr/container_registry)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/radarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](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?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/radarr)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/radarr.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/radarr)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-radarr%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-radarr/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Flsio-ci.ams3.digitaloceanspaces.com%2Flinuxserver%2Fradarr%2Flatest%2Fci-status.yml)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/radarr/latest/index.html)
2019-10-01 05:10:17 +00:00
2020-06-29 07:29:55 +00:00
[Radarr](https://github.com/Radarr/Radarr) - A fork of Sonarr to work with movies à la Couchpotato.
2020-05-05 05:09:53 +00:00
2020-06-30 05:09:52 +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 |
2020-06-30 05:09:52 +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 |
2020-06-30 05:09:52 +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 |
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.
2020-10-06 05:10:20 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-08 15:52:33 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-07 16:45:10 +00:00
version: "2.1"
2019-02-08 15:52:33 +00:00
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:
2020-03-23 20:14:41 +00:00
- /path/to/data:/config
- /path/to/movies:/movies
- /path/to/downloadclient-downloads:/downloads
2019-02-08 15:52:33 +00:00
ports:
- 7878:7878
restart: unless-stopped
```
2020-10-06 05:10:20 +00:00
### docker cli
```
docker run -d \
--name=radarr \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e UMASK_SET=022 `#optional` \
-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-02-08 15:52:33 +00:00
## Parameters
2020-06-30 05:09:52 +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
2020-06-30 05:09:52 +00:00
### Ports (`-p`)
2019-02-08 15:52:33 +00:00
| Parameter | Function |
2020-06-30 05:09:52 +00:00
| :----: | --- |
2019-02-08 15:52:33 +00:00
| `7878` | The port for the Radarr webinterface |
2020-06-30 05:09:52 +00:00
### Environment Variables (`-e`)
2019-02-08 15:52:33 +00:00
| Env | Function |
2020-06-30 05:09:52 +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
2020-06-30 05:09:52 +00:00
### Volume Mappings (`-v`)
2019-02-08 15:52:33 +00:00
| Volume | Function |
2020-06-30 05:09:52 +00:00
| :----: | --- |
2019-02-08 15:52:33 +00:00
| `/config` | Database and Radarr configs |
2020-06-30 05:09:52 +00:00
| `/movies` | Location of Movie library on disk (See note in Application setup) |
| `/downloads` | Location of download managers output directory (See note in Application setup) |
2020-05-05 05:09:53 +00:00
2020-06-30 05:09:52 +00:00
## Environment variables from files (Docker secrets)
2020-06-02 05:10:24 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2020-06-30 05:09:52 +00:00
```
2020-06-02 05:10:24 +00:00
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
2020-06-30 05:09:52 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
2020-04-07 16:45:10 +00:00
2019-02-08 15:52:33 +00:00
## User / Group Identifiers
2020-06-30 05:09:52 +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
2020-06-30 05:09:52 +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).
2020-03-24 00:38:30 +00:00
2020-08-24 19:10:36 +00:00
**Special Note**: Following our current folder structure will result in an inability to hardlink from your downloads to your movies folder because they are on seperate volumes. To support hardlinking, ensure that the movies and downloads data are on a single volume. For example, if you have `/mnt/storage/Movies` and `/mnt/storage/downloads/completed/Movies`, you would want something like `/mnt/storage:/media` for your volume. Then you can hardlink from `/media/downloads/completed` to `/media/Movies`.
2020-03-24 00:38:30 +00:00
2020-09-27 14:48:13 +00:00
Another item to keep in mind, is that within Radarr itself, you should map your download client folder to your radarr folder. Navigate to **Settings -> Download Client -> Advanced Settings -> Remote Path Mappings**. Add a new mapping, and set: the Host as the same entry of the Host in your download client (for example its IP address), the Remote Path as `/downloads/Movies` (relative to the internal container path), and Local Path as `/media/downloads/completed/Movies`, assuming you have folders to separate your downloaded data types.
2020-06-30 05:09:52 +00:00
2019-10-01 05:10:17 +00:00
2020-04-07 16:45:10 +00:00
## Docker Mods
2020-10-06 05:10:20 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=radarr&query=%24.mods%5B%27radarr%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=radarr "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-07 16:45:10 +00:00
2020-10-06 05:10:20 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-07 16:45:10 +00:00
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
2020-04-10 01:42:49 +00:00
* **05.04.20:** - Move app to /app.
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.