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

Passwords

API Keys

KeepAPI theseKeys securelyare storedused infor authenticating access to and communication with another service.  These should be treated as if they are a passwordsecure manager, such as VaultWarden.password.

DB_ROOT_PASSHardCover API

This isservices uses API services to retrieve its required metadata.  These API keys are free, but need to be manually requested through the passwordHardCover thatwebsite. will be used for root access to the database.

It is important to use secure, randomly generated password.

You canwill use a random alphanumeric string from a password manager, or open the terminal and run the command:

tr -dc 'A-Za-z0-9!"#$%&'\''()*+,-./:;<=>?@[\]^_`{|}~' </dev/urandom | head -c 32; echo

This pulls a random string from the 'urandom' device, removes unwanted characters and trim itneed to create an appropriateaccount length.with your personal e-mail address.

OWNCLOUD_ADMIN_PASSWORDGoogle Books API

This isservices uses API services to retrieve its required metadata.  These API keys are free, but need to be manually requested through the passwordGoogle forBooks 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 administratorLibraryThings website. 

You will need to create an account thatwith 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 be used within the web interface.

It is importantneed to usecreate securean passphraseaccount thatwith isyour easy-to-remember.personal e-mail address.

Back to top