Readarr#

Readarr Readarr is a ebook collection manager for Usenet and BitTorrent users.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: unstable

SETUP#

Enabling readarr#

Command:#

vlab set readarr.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
enable: True

Finalising changes:#

run: vlab update_one service=readarr

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, readarr makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=readarr to complete the changes

ACCESS#

readarr (HTTPS) link: https://readarr.vivumlab.xyz/ readarr (HTTP) link: http://readarr.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set readarr.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
https_only: True
Finalising changes:#

run: vlab update_one service=readarr

AUTH#

Default: False
Options: True/False

Command:#

vlab set readarr.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
auth: True
Finalising changes:#

run: vlab update_one service=readarr

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set readarr.domain readarr.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
domain: readarr.com
Finalising changes:#

run: vlab update_one service=readarr

SUBDOMAIN#

Default: readarr
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set readarr.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
subdomain: media
Finalising changes:#

run: vlab update_one service=readarr

VERSION#

Default: unstable
NOTE: Ensure that the version exists

Command:#

vlab set readarr.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

readarr
version: 2.7
Finalising changes:#

run: vlab update_one service=readarr

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.