thespad/whisparr repository overview

⁠thespad/whisparr⁠

whisparr⁠ is an adult movie collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new movies and will interface with clients and indexers to grab, sort, and rename them. It can also be configured to automatically upgrade the quality of existing files in the library when a better quality format becomes available.

⁠Supported Architectures

Our images support multiple architectures and simply pulling ghcr.io/thespad/whisparr:latest should retrieve the correct image for your arch.

The architectures supported by this image are:

⁠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.

⁠Application Setup

Webui is accessible at http://SERVERIP:PORT

⁠Usage

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

⁠docker-compose (recommended⁠)

---
services:
  whisparr:
    image: ghcr.io/thespad/whisparr:latest
    container_name: whisparr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/whisparr/config:/config
      - /path/to/downloads:/downloads
    ports:
      - 6969:6969
    restart: unless-stopped

⁠docker cli

docker run -d \
  --name=whisparr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 6969:6969 \
  -v /path/to/whisparr/config:/config \
  -v /path/to/downloads:/downloads \
  --restart unless-stopped \
  ghcr.io/thespad/whisparr:latest

⁠Parameters

Container 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.

⁠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)

⁠Support Info

• Shell access whilst the container is running: docker exec -it whisparr /bin/bash
• To monitor the logs of the container in realtime: docker logs -f whisparr

⁠Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. We do not recommend or support updating apps inside the container. Please consult the Application Setup⁠ section above to see if it is recommended for the image.

Below are the instructions for updating containers:

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull whisparr
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d whisparr
• You can also remove the old dangling images: docker image prune

⁠Via Docker Run

• Update the image: docker pull ghcr.io/thespad/whisparr
• Stop the running container: docker stop whisparr
• Delete the container: docker rm whisparr
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/thespad/docker-whisparr.git
cd docker-whisparr
docker build \
  --no-cache \
  --pull \
  -t ghcr.io/thespad/whisparr:latest .

The arm variants can be built on x86_64 hardware and vice versa using lscr.io/linuxserver/qemu-static

docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

⁠Versions

• 14.07.26: - Rebase to Alpine 3.24.
• 25.05.26: - Switch to Github releases.
• 15.02.26: - Rebase to Alpine 3.23.
• 07.10.25: - Add v3 branch.
• 25.07.25: - Rebase to Alpine 3.22.
• 02.02.25: - Rebase to Alpine 3.21.
• 26.05.24: - Rebase to Alpine 3.20.
• 30.12.23: - Rebase to Alpine 3.19.
• 14.05.23: - Rebase to Alpine 3.18. Drop support for armhf.
• 09.12.22: - Rebase to 3.17.
• 23.09.22: - Rebase to 3.16, migrate to s6v3.
• 01.04.22: - Initial Release.