kopia lustrzana https://github.com/linuxserver/docker-documentation
182 wiersze
9.6 KiB
Markdown
182 wiersze
9.6 KiB
Markdown
|
---
|
||
|
|
title: readarr
|
||
|
|
---
|
||
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||
|
|
<!-- Please read the https://github.com/linuxserver/docker-readarr/blob/nightly/.github/CONTRIBUTING.md -->
|
||
|
|
|
||
|
|
# [linuxserver/readarr](https://github.com/linuxserver/docker-readarr)
|
||
|
|
|
||
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Freadarr)
|
||
|
|
[](https://github.com/linuxserver/docker-readarr)
|
||
|
|
[](https://github.com/linuxserver/docker-readarr/releases)
|
||
|
|
[](https://github.com/linuxserver/docker-readarr/packages)
|
||
|
|
[](https://gitlab.com/linuxserver.io/docker-readarr/container_registry)
|
||
|
|
[](https://quay.io/repository/linuxserver.io/readarr)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/readarr)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/readarr)
|
||
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-readarr/job/nightly/)
|
||
|
|
[](https://ci-tests.linuxserver.io/linuxserver/readarr/latest/index.html)
|
||
|
|
|
||
|
|
[Readarr](https://github.com/Readarr/Readarr) - Book Manager and Automation (Sonarr for Ebooks)
|
||
|
|
|
||
|
|
## Supported Architectures
|
||
|
|
|
||
|
|
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/).
|
||
|
|
|
||
|
|
Simply pulling `lscr.io/linuxserver/readarr:nightly` 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:
|
||
|
|
|
||
|
|
| Architecture | Available | Tag |
|
||
|
|
| :----: | :----: | ---- |
|
||
|
|
| x86-64 | ✅ | amd64-\<version tag\> |
|
||
|
|
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||
|
|
| armhf| ✅ | arm32v7-\<version tag\> |
|
||
|
|
|
||
|
|
## Version Tags
|
||
|
|
|
||
|
|
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
|
||
|
|
|
||
|
|
| Tag | Available | Description |
|
||
|
|
| :----: | :----: |--- |
|
||
|
|
| latest | ❌ | |
|
||
|
|
| nightly | ✅ | Nightly Readarr releases |
|
||
|
|
|
||
|
|
## Application Setup
|
||
|
|
|
||
|
|
Access the webui at `<your-ip>:8787`, for more information check out [Readarr](https://github.com/Readarr/Readarr).
|
||
|
|
|
||
|
|
### Media folders
|
||
|
|
|
||
|
|
We have set `/books` and `/downloads` as ***optional paths***, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
|
||
|
|
|
||
|
|
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
|
||
|
|
|
||
|
|
The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
||
|
|
|
||
|
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
---
|
||
|
|
version: "2.1"
|
||
|
|
services:
|
||
|
|
readarr:
|
||
|
|
image: lscr.io/linuxserver/readarr:nightly
|
||
|
|
container_name: readarr
|
||
|
|
environment:
|
||
|
|
- PUID=1000
|
||
|
|
- PGID=1000
|
||
|
|
- TZ=Europe/London
|
||
|
|
volumes:
|
||
|
|
- /path/to/data:/config
|
||
|
|
- /path/to/books:/books #optional
|
||
|
|
- /path/to/downloadclient-downloads:/downloads #optional
|
||
|
|
ports:
|
||
|
|
- 8787:8787
|
||
|
|
restart: unless-stopped
|
||
|
|
```
|
||
|
|
|
||
|
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||
|
|
|
||
|
|
```bash
|
||
|
|
docker run -d \
|
||
|
|
--name=readarr \
|
||
|
|
-e PUID=1000 \
|
||
|
|
-e PGID=1000 \
|
||
|
|
-e TZ=Europe/London \
|
||
|
|
-p 8787:8787 \
|
||
|
|
-v /path/to/data:/config \
|
||
|
|
-v /path/to/books:/books `#optional` \
|
||
|
|
-v /path/to/downloadclient-downloads:/downloads `#optional` \
|
||
|
|
--restart unless-stopped \
|
||
|
|
lscr.io/linuxserver/readarr:nightly
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
### Ports (`-p`)
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :----: | --- |
|
||
|
|
| `8787` | The port for the Readarr webinterface |
|
||
|
|
|
||
|
|
### 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 Readarr |
|
||
|
|
|
||
|
|
### Volume Mappings (`-v`)
|
||
|
|
|
||
|
|
| Volume | Function |
|
||
|
|
| :----: | --- |
|
||
|
|
| `/config` | Database and Readarr configs |
|
||
|
|
| `/books` | Location of Book library on disk (See note in Application setup) |
|
||
|
|
| `/downloads` | Location of download managers output directory (See note in Application setup) |
|
||
|
|
|
||
|
|
#### Miscellaneous Options
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :-----: | --- |
|
||
|
|
|
||
|
|
## Environment variables from files (Docker secrets)
|
||
|
|
|
||
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||
|
|
|
||
|
|
As an example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
-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
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## 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`.
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ id username
|
||
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Docker Mods
|
||
|
|
|
||
|
|
[](https://mods.linuxserver.io/?mod=readarr "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
## Support Info
|
||
|
|
|
||
|
|
* Shell access whilst the container is running:
|
||
|
|
* `docker exec -it readarr /bin/bash`
|
||
|
|
* To monitor the logs of the container in realtime:
|
||
|
|
* `docker logs -f readarr`
|
||
|
|
* Container version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' readarr`
|
||
|
|
* Image version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/readarr:nightly`
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
* **21.01.22:** - Remove chromaprint as it's no longer a required dependency.
|
||
|
|
* **01.01.22:** - Add chromaprint for audio fingerprinting.
|
||
|
|
* **28.07.21:** - Initial Release.
|