Portainer Templates logo

Portainer Templates

Readarr (container) Readarr (container)

DownloadersMediaapp Books

Readarr - Book Manager and Automation (Sonarr for Ebooks)

Configuration

Type
Container
Image
ghcr.io/linuxserver/readarr:nightly
Ports
8787/tcp
Volumes
/config : /opt/mediadepot/apps/readarr/downloads : /media/storage/downloads/ebooks/books : /media/storage/ebooks/blackhole : /media/temp/blackhole/ebooks/etc/localtime : /etc/localtime
Env vars
PGID=15000PUID=15000TZ=America/Los_Angeles
Labels
traefik.enable=truetraefik.http.services.readarr.loadbalancer.server.port=8787traefik.http.routers.readarr.entrypoints=websecuretraefik.http.routers.readarr.tls.certresolver=mydnschallenge

Template by mediadepot

Standalone Install

Select an install method, to see config/commands for deploying Readarr (container)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Readarr (container), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

More install options in our documentation.

Serve Readarr (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying readarr-container.example.com to http://readarr:8787

Add this to your Caddyfile

readarr-container.example.com {
	reverse_proxy http://readarr:8787
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs readarr
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Published on a random port

This template exposes 8787/tcp without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port readarr

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 15000:15000 /opt/mediadepot/apps/readarr (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 15000:15000) to match your own user, found with id $USER
  • Seeing "read-only file system"? /etc/localtime is mounted read-only on purpose, the app isn't meant to write there.

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/linuxserver/readarr:nightly

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A single container

Readarr (container) runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Readarr (container) needs bundled into one download. This template pulls ghcr.io/linuxserver/readarr:nightly, which Docker fetches once and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Readarr (container)'s comes from the GitHub Container Registry, published by linuxserver.

Version tags

The bit after the colon in the image name is the version tag. This one pins nightly, so every redeploy gives you that exact build until you bump it yourself.

Ports

A port is the door the app answers on. Here the app exposes a port but leaves the host side blank, so Docker picks a free one for you. It opens:

  • 8787, published on a random host port

Volumes

A volume is where Readarr (container) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /config from /opt/mediadepot/apps/readarr on the host
  • /downloads from /media/storage/downloads/ebooks on the host
  • /books from /media/storage/ebooks on the host
  • /blackhole from /media/temp/blackhole/ebooks on the host
  • /etc/localtime from /etc/localtime on the host, read-only

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Readarr (container) takes 3 of them, all with defaults you can leave alone or tweak:

  • PGID, defaults to 15000
  • PUID, defaults to 15000
  • TZ, defaults to America/Los_Angeles

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Readarr (container) sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container readarr. That's what you'll spot in the containers list and use in commands like docker logs readarr.

Labels

Labels are small notes pinned to the container. They don't change how Readarr (container) behaves, but other tools read them, most often a reverse proxy like Traefik working out which apps to route where. This template sets:

  • traefik.enable=true
  • traefik.http.services.readarr.loadbalancer.server.port=8787
  • traefik.http.routers.readarr.entrypoints=websecure
  • traefik.http.routers.readarr.tls.certresolver=mydnschallenge

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Readarr (container) up. Add the template list to Portainer once, then deploying Readarr (container) is a click rather than a wall of config.