Wiki > Listenarr

Setup

Intro

Listenarr is an audiobook collection manager for Usenet and BitTorrent users, similar to Sonarr and Radarr but for audiobooks. It can search, download, and organize your library automatically using metadata from Audible and other sources.

The software will be configured in the /home/user/listenarr directory.

You will need a port number to access Listenarr. Port 13130 has been automatically generated for you, but you may use another 5 digit port between 10000 and 32767.

Pre-requisites

The directions below assume:

1. You have a directory of audiobook files in /home/user/files/audiobooks
2. Your download client saves completed downloads to /home/user/Downloads

Note: If you do not have these directories, create them before starting the installation with mkdir -p ~/files/audiobooks ~/Downloads. Alternatively, you can use your existing folders and change the directory paths for your files as needed.

Installation

1. Connect to your slot through SSH

2. Create the directories needed for Listenarr

    mkdir -p ~/listenarr ~/listenarr/config
   

3. Create a compose file

    touch ~/listenarr/docker-compose.yml
   

4. Edit the compose file

    nano ~/listenarr/docker-compose.yml
   

5. Copy the following, changing the directory paths for your files as needed, and paste it into nano.

services:
  listenarr:
    image: ghcr.io/listenarrs/listenarr:canary
    ports:
      - 13130:4545
    volumes:
      - /home/user/files:/Audiobooks
      - /home/user/Downloads:/app/downloads
      - /home/user/listenarr/config:/app/config
    restart: unless-stopped

Save the file by pressing Ctrl+S then press Ctrl+X to exit nano

6. Start the compose file

    podman-compose -f ~/listenarr/docker-compose.yml up -d
   

Accessing Listenarr

You will be able to access Listenarr at http://server.whatbox.ca:13130 roughly a minute after it starts. You will need to configure authentication on your first visit by browsing to http://server.whatbox.ca:13130/settings#general.

Inside Listenarr, your audiobooks directory is available at /Audiobooks and your downloads directory at /app/downloads. Use /Audiobooks when adding your root folder.

Using SSL with a Managed App Link

If you want to access your Listenarr instance with HTTPS access, add a custom app managed link named listenarr with port 13130 and select Enable websockets (optional). Listenarr will then be available at https://listenarr.example.box.ca.

Updating Listenarr

Shut down the container with

    podman-compose -f ~/listenarr/docker-compose.yml down -t 300

and wait for it to shut down. Then, run

    podman-compose -f ~/listenarr/docker-compose.yml pull

to download the latest program image. Then, start the container again

    podman-compose -f ~/listenarr/docker-compose.yml up -d

Removing Listenarr

Shut down and remove the container with

    podman-compose -f ~/listenarr/docker-compose.yml down -t 300

and wait for it to shut down. Then, remove the program image

    podman rmi ghcr.io/listenarrs/listenarr:canary

Finally, delete the Listenarr directory. This permanently removes your Listenarr settings and database, but does not touch your audiobooks or downloads

    rm -rf ~/listenarr