Skip to content

Repository files navigation

What is this?

This is a fork of docker-prowlarr from the linuxserver.io team that adds AudioBookBay back into Prowlarr. The application is exactly identical to linuxserver.io's except for the User-Agent that gets sent to AudioBookBay.

Why do I need it?

AudioBookBay has blocked Prowlarr's User-Agent from accessing their site making ABB unusable with the offical docker image(s). By changing the User-Agent we are able to bypass ABB's restrictions and continue to use Prowlarr to its fullest potential.

Credit

I am not the one who came up with this solution. The original solution was found and implemented by WardDrake. Kudos to them for making this happen. His method required a manual process and as such his container has fallen out of date. I have made the process automatic with hopes to keep the container up to date with Prowlarr's dev branch.

What's next?

This is a drop-in replacement to the Linux Server docker image. If you're already using their container, simply change your image over to this one. If you're not running Prowlarr yet, please see the documentation below.

Prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all).

prowlarr

Supported Architectures

Currently, only x86-64 architecture is supported. Please feel free to use the Dockerfile to generate your own version.

The architectures supported by this image are:

Architecture Available Tag
x86-64 amd64-<version tag>
arm64 arm64-<version tag>
armhf

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.

Tag Available Description
latest Prowlarr stable releases
develop Prowlarr releases from their develop branch
nightly Prowlarr releases from their nightly branch

Application Setup

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

Setup info can be found here.

Usage

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

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  prowlarr:
    image: bitlessbyte/prowlarr:latest
    container_name: prowlarr
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/data:/config
    ports:
      - 9696:9696
    restart: unless-stopped
docker run -d \
  --name=prowlarr \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 9696:9696 \
  -v /path/to/data:/config \
  --restart unless-stopped \
  bitlessbyte/prowlarr: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 9696 The port for the Prowlarr webinterface
-e PUID=1000 for UserID - see below for explanation
-e PGID=1000 for GroupID - see below for explanation
-e TZ=Etc/UTC specify a timezone to use, see this list.
-v /config Database and Prowlarr configs

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

Docker Mods Docker Universal 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 prowlarr /bin/bash
  • To monitor the logs of the container in realtime: docker logs -f prowlarr
  • container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' prowlarr
  • image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' bitlessbyte/prowlarr:latest

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), 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 prowlarr
  • Let compose update all containers as necessary: docker-compose up -d
    • or update a single container: docker-compose up -d prowlarr
  • You can also remove the old dangling images: docker image prune

Via Docker Run

  • Update the image: docker pull bitlessbyte/prowlarr:latest
  • Stop the running container: docker stop prowlarr
  • Delete the container: docker rm prowlarr
  • 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

Via Watchtower auto-updater (only use if you don't remember the original parameters)

  • Pull the latest image at its tag and replace it with the same env variables in one run:

    docker run --rm \
    -v /var/run/docker.sock:/var/run/docker.sock \
    containrrr/watchtower \
    --run-once prowlarr
  • You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.

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.

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/BitlessByte0/docker-prowlarr-abb.git
cd docker-prowlarr-abb
docker build \
  --no-cache \
  --pull \
  -t bitlessbyte/prowlarr:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Credits

Most of this documentation is thanks to the team over at LinuxServer.io

Versions

  • 08.15.25: - Created arm64 variant and fixed bug that caused search to error when capital letters were used in the query.
  • 07.07.25: - Updated Dockerfile so that both Prowlarr's master and develop (which changes to .net8.0) branches can be built.
  • 08.29.23: - Change User-Agent to bypass AudioBookBay's block.
  • 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
  • 03.01.23: - Publish stable release.
  • 20.02.22: - Rebase develop branch to Alpine.
  • 06.06.21: - Initial realease.

About

No description, website, or topics provided.

Resources

Contributing

Stars

21 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages