zimme/couchpotato repository overview

The LinuxServer.io⁠ team brings you another container release featuring easy user mapping and community support. Find us for support at:

• forum.linuxserver.io⁠
• IRC⁠ on freenode at #linuxserver.io
• Podcast⁠ covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!

⁠linuxserver/couchpotato

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.

⁠Usage

docker create \
	--name=couchpotato \
	-v <path to data>:/config \
	-v <path to data>:/downloads \
	-v <path to data>:/movies \
	-e PGID=<gid> -e PUID=<uid> -e PGIDS="<gid> <gid>" \
	-e TZ=<timezone> \
	-e UMASK_SET=<022> \
	-p 5050:5050 \
	linuxserver/couchpotato

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.

• -p 5050 - the port(s)
• -v /config - Couchpotato Application Data
• -v /downloads - Downloads Folder
• -v /movies - Movie Share
• -e PGID for GroupID - see below for explanation
• -e PUID for UserID - see below for explanation
• -e PGIDS for GroupIDs - see below for explanation
• -e UMASK_SET for umask setting of couchpotato, optional , default if left unset is 022.
• -e TZ for timezone information, eg Europe/London

It is based on alpine-linux with S6 overlay, for shell access whilst the container is running do docker exec -it couchpotato /bin/bash.

⁠User / Group Identifiers

Sometimes when using data 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, group PGID and groups PGIDS. Ensure the data volume directory on the host is owned by the same user you specify and it will "just work" ™.

In this instance PUID=1001 and PGID=1001. To find yours use id user as below:

  $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

⁠Setting up the application

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

⁠Info

• 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" }}' linuxserver/couchpotato

⁠Versions

• 06.12.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.