​​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​ ​​​

​Couchpotato is an automatic NZB and torrent downloader. You can keep a movies I want list and it will search for NZBs/torrents of these movies every X hours. Once a movie is found, it will send it to SABnzbd or download the torrent to a specified directory.

Supported Architectures

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 and our announcement here.

Simply pulling ghcr.io/linuxserver/couchpotato 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:

Application Setup

Access the webui at <your-ip>:5050, for more information check out CouchPotato.

Usage

Here are some example snippets to help you get started creating a container from this image.

docker-compose (recommended)

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  couchpotato:
    image: ghcr.io/linuxserver/couchpotato
    container_name: couchpotato
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/appdata/config:/config
      - /path/to/downloads:/downloads
      - /path/to/movies:/movies
    ports:
      - 5050:5050
    restart: unless-stopped

docker cli

docker run -d \
  --name=couchpotato \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 5050:5050 \
  -v /path/to/appdata/config:/config \
  -v /path/to/downloads:/downloads \
  -v /path/to/movies:/movies \
  --restart unless-stopped \
  ghcr.io/linuxserver/couchpotato

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)

Environment Variables (-e)

Volume Mappings (-v)

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-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 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:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

​​​ ​​​

We publish various 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 couchpotato /bin/bash

• To monitor the logs of the container in realtime:

  • docker logs -f couchpotato

• Container version number

  • docker inspect -f '{{ index .Config.Labels "build_version" }}' couchpotato

• Image version number

  • docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/couchpotato

Versions

• 29.01.21: - Deprecate UMASK_SET in favor of UMASK in baseimage, see above for more information.

• 23.01.21: - Rebasing to alpine 3.13.

• 10.06.19: - Add back unrar & unzip that were accidentally left out during rebase.

• 06.06.19: - Rebasing to alpine 3.12.

• 19.12.19: - Rebasing to alpine 3.11.

• 28.06.19: - Rebasing to alpine 3.10.

• 23.03.19: - Switching to new Base images, shift to arm32v7 tag.

• 22.02.19: - Rebasing to alpine 3.9.

• 14.01.19: - Multi-arch builds.

• 16.08.18: - Rebase to alpine 3.8.

• 06.11.17: - Rebase to alpine 3.7.

• 20.07.17: - Internal git pull instead of at runtime, add UMASK_SET variable.

• 12.07.17: - Add inspect commands to README, move to jenkins build and push

• 25.05.17: - Rebase to alpine 3.6

• 07.02.17: - Rebase to alpine 3.5.

• 11.11.16: - Stop cp logging to docker log (they are accessible in the webui and the config folder).

• 30.09.16: - Fix umask.

• 09.09.16: - Add layer badges to README.

• 27.08.16: - Add badges to README.

• 08.08.16: - Rebase to alpine linux.

• 12.11.15: - Misc Code Cleanup.

• 02.10.15: - Change to python baseimage.

• 28.07.15: - Updated to latest baseimage (for testing), and a fix to autoupdate.