Skip to content

Latest commit

 

History

History
96 lines (73 loc) · 5.05 KB

README.md

File metadata and controls

96 lines (73 loc) · 5.05 KB

GitHub Release Commits Image Size Docker Pulls GitHub Stars Docker Stars

GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub Actions Workflow Status

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:

Architecture Available Tag
amd64 latest
arm64 latest

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)

Compatible with docker-compose v2 schemas.

---
services:
  get_iplayer:
    image: ghcr.io/thespad/whisparr:latest
    container_name: whisparr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=America/New_York
    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=America/New_York \
  -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.

Parameter Function
-p 6969 Web GUI
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=America/New_York Specify a timezone to use EG America/New_York
-v /config Contains all relevant configuration files.
-v /downloads Storage location for all get_iplayer download files.

Image Update Notifications - Diun (Docker Image Update Notifier)

  • We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Versions

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