markbeep/audiobookrequest repository overview

⁠AudioBookRequest

Your tool for handling audiobook requests on a Plex/Audiobookshelf/Jellyfin instance.

If you've heard of Overseer, Ombi, or Jellyseer; this is in the similar vein, but for audiobooks.

⁠Table of Contents

• Getting Started⁠
  • Quick Start⁠
  • Usage⁠
    • Auto download⁠
    • Notifications⁠
  • Alternative Deployments⁠
    • Environment Variables⁠

⁠Getting Started

⁠Quick Start

Run the image directly:

docker run -p 8000:8000 -v $(pwd)/config:/config markbeep/audiobookrequest:1

Then head to http://localhost:8000⁠.

⁠Usage

1. Logging in the first time the login-type and root admin user has to be configured.
2. Head to Settings>Users to create accounts for your friends.
3. Any user can search for books and request them by clicking the + button.
4. The admin can head to the wishlist to see all the books that have been requested.

⁠Auto download

Auto-downloading enables requests by Trusted and Admin users to directly start downloading once requested.

1. Ensure your Prowlarr instance is correctly set up with any indexers and download clients you want. More info⁠.
2. On Prowlarr, head to Settings>General and copy the API Key.
3. On AudioBookRequest, head to Settings>Prowlarr and enter the API key as well as the base URL of your Prowlarr instance, i.e. https://prowlarr.example.com.
4. Head to Settings>Download to configure the automatic download settings:
   1. Enable Auto Download at the top.
   2. The remaining heuristics determine the ranking of any sources retrieved from Prowlarr.
   3. Indexer flags allow you to add priorities to certain sources like freeleeches.

⁠Notifications

Notifications depend on Apprise⁠.

1. Ensure you have a working Apprise instance.
2. On Apprise, create a new configuration. For example paste your Discord webhook link (https://discord.com/api/webhooks/<channel>/<id>) into the configuration.
3. On Apprise, copy the notification url along the format of https://apprise.example.com/notify/<id>.
4. On AudioBookRequest, head to Settings>Notifications and add the URL.
5. Configure the remaining settings. The event variables are case sensitive.

⁠Alternative Deployments

NOTE: It is not recommended to use :latest in case of incompatible changes that are not backwards compatible. For versioning, SemVer⁠ is used.

For experimental builds (latest commits to main), the :nightly version can be used.

Docker compose

services:
  web:
    image: markbeep/audiobookrequest:1
    ports:
      - "8000:8765"
    environment:
      - ABR_APP__PORT: 8765
    volumes:
      - ./config:/config

Kubernetes

apiVersion: apps/v1
kind: Deployment
metadata:
  name: audiobookrequest
  labels:
    app: audiobookrequest
spec:
  replicas: 1
  selector:
    matchLabels:
      app: audiobookrequest
  template:
    metadata:
      labels:
        app: audiobookrequest
    spec:
      containers:
        - name: audiobookrequest
          image: markbeep/audiobookrequest:1
          imagePullPolicy: Always
          volumeMounts:
            - mountPath: /config
              name: abr-config
          env:
            - name: ABR_APP__PORT
              value: "8765"
          ports:
            - name: http-request
              containerPort: 8765
      volumes:
        - name: abr-config
          hostPath:
            path: /mnt/disk/AudioBookRequest/

⁠Environment Variables