Paperless#

Paperless is a document management server. Point it at a folder on your NAS that your scanner is set to scan to, scan all your paper docs, have a searchable secure document archive.

amd64
arm64
armv7

Information#

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

SETUP#

Enabling paperless#

Command:#

vlab set paperless.enable True

File alteration:#

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

eg.

paperless
enable: True

Finalising changes:#

run: vlab update_one service=paperless

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#

To create a user, ssh into your server and run the following: docker exec -it paperless ./manage.py createsuperuser

You will be prompted to enter a username, email (optional) and password. Once the user has been created successfully, you may need to break (Ctrl+C) This is the login info that can be used at https://paperless.vivumlab.xyz/ or http://paperless.vivumlab.xyz/

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=paperless to complete the changes

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set paperless.https_only True

File alteration:#

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

eg.

paperless
https_only: True
Finalising changes:#

run: vlab update_one service=paperless

AUTH#

Default: False
Options: True/False

Command:#

vlab set paperless.auth True

File alteration:#

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

eg.

paperless
auth: True
Finalising changes:#

run: vlab update_one service=paperless

DOMAIN#

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

Command:#

vlab set paperless.domain paperless.com

File alteration:#

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

eg.

paperless
domain: paperless.com
Finalising changes:#

run: vlab update_one service=paperless

SUBDOMAIN#

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

Command:#

vlab set paperless.subdomain media

File alteration:#

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

eg.

paperless
subdomain: media
Finalising changes:#

run: vlab update_one service=paperless

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set paperless.version 2.7

File alteration:#

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

eg.

paperless
version: 2.7
Finalising changes:#

run: vlab update_one service=paperless

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.