Skip to main content

Preparation

There are some things we need to do in preparation to install this service.

Volumes

Persistent Data

This is where the service will store its own application data and ensures we can quickly update the service image.

Ensure your user has permissions to access the folder.

Media Folders

This service will need access to the folders where you store your media files. 

Ensure your user has permissions to access the folder.

Download Folders

This service will need access to the folder where you torrent or usenet folder store their completed downloads.

Ensure your user has permissions to access the folder.

Environment

TZ

This is the current time zone formatted using the tz database.

For example: America/Vancouver

PUID

This is the numeric ID of the user account on Debian.  If you are unsure, open a terminal and run:

id -u
PGID

This is the numeric ID of the user account's group on Debian.  If you are unsure, open a terminal and run:

id -g

API Keys

API Keys are used for authenticating access to and communication with another service.  These should be treated as if they are a secure password.

HardCover API

This services uses API services to retrieve its required metadata.  These API keys are free, but need to be manually requested through the HardCover website

You will need to create an account with your personal e-mail address.

Google Books API

This services uses API services to retrieve its required metadata.  These API keys are free, but need to be manually requested through the Google Books website

You will need to create an account with your personal e-mail address.

LibraryThings Developer Key

This services uses API services to retrieve its required metadata.  These API keys are free, but need to be manually requested through the LibraryThings website

You will need to create an account with your personal e-mail address.

ComicVine API

This services uses the ComicVine API to retrieve its required metadata.  These API keys are free, but need to be manually requested through the ComicVine API website.

You will need to create an account with your personal e-mail address.