Whatbox Logo
Login for certain variables to be updated with your slot's information

Wiki > Bookshelf

At this time, Whatbox servers have limited support for Bookshelf and containers. It may stop working at any time.

Setup

Intro

Bookshelf is a revival of Readarr, an ebook and audiobook collection manager for Usenet and BitTorrent users.

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

Installation

  1. Connect to your slot through SSH

  2. Create the directories needed for Bookshelf

     mkdir -p ~/bookshelf ~/bookshelf/config
    
  3. Create a compose file

     touch ~/bookshelf/docker-compose.yml
    
  4. Edit the compose file

     nano ~/bookshelf/docker-compose.yml
    
  5. Copy the following text and paste it into nano.

services:
  bookshelf:
    image: ghcr.io/pennydreadful/bookshelf:hardcover
    ports:
      - 22881:8787
    volumes:
      - /home/user:/home/user
      - /home/user/bookshelf/config:/config
    environment:
      - PUID=0
      - PGID=0
    restart: unless-stopped

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

  1. Start the compose file

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

Accessing Bookshelf

You will be able to access Bookshelf at http://server.whatbox.ca:22881 roughly a minute after it starts. You will need to set up authentication on your first visit.