Overview

ReadMeABook is an audiobook library management and automation system, purpose-built for audiobooks. Request a book, and it handles the rest: searches indexers, downloads, organizes files, and triggers a library scan.

Runtime arguments

Web UI: http://[IP]:[PORT:3030]/
Network: bridge
Shell: bash
Privileged: false
Extra Params: --restart=unless-stopped

Template configuration

Web UI Host PortPorttcp

Port for ReadMeABook's web interface.

Target: 3030
Default: 3030
Value: 3030

Config LocationPathrw

Persistent config files

Target: /app/config
Default: /mnt/user/appdata/readmeabook/config
Value: /mnt/user/appdata/readmeabook/config

Download LocationPathrw

Both your download client and RMAB must see files at the SAME path. See: https://github.com/kikootwo/ReadMeABook/blob/main/documentation/deployment/volume-mapping.md

Target: /downloads
Default: /mnt/user/data/downloads

Media LibraryPathrw

Your audiobook/ebook library

Target: /media
Default: /mnt/user/data/media/audiobooks

Postgres Storage LocationPathrw

Target: /var/lib/postgresql/data
Default: /mnt/user/appdata/readmeabook/pgdata
Value: /mnt/user/appdata/readmeabook/pgdata

Redis Storage LocationPathrw

Target: /var/lib/redis
Default: /mnt/user/appdata/readmeabook/redis
Value: /mnt/user/appdata/readmeabook/redis

App CachePathrw

Target: /app/cache
Default: /mnt/user/appdata/readmeabook/cache
Value: /mnt/user/appdata/readmeabook/cache

PUBLIC_URLVariable

Public URL if accessing from outside localhost. Required for OAuth.

Default: https://audiobooks.example.com

PUIDVariable

Default: 99
Value: 99

PGIDVariable

Default: 100
Value: 100

Links

Template Support Registry Project

Details

Repository

ghcr.io/kikootwo/readmeabook:latest

Registry

https://github.com/kikootwo/ReadMeABook/pkgs/container/readmeabook

Last Updated2026-05-31

First Seen2026-02-12

Run ReadMeABook on Unraid.

ReadMeABook is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.

Explore Unraid OS