paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-10-30 03:56:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Drop STORAGE_TYPE in favour of just using PAPERLESS_PASSPHRASE

Browse Source
This commit is contained in:
Daniel Quinn
2018-05-27 23:20:04 +01:00
parent 5643d89270
commit 6e1f2b3f03
3 changed files with 16 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/documents/consumer.py
View File

@@ -48,15 +48,9 @@ class Consumer:
except FileExistsError:
pass
acceptable_storage_types = [_[0] for _ in Document.STORAGE_TYPES]
if settings.STORAGE_TYPE not in acceptable_storage_types:
raise ConsumerError(
'Invalid STORAGE_TYPE "{}" defined. It must be one of {}. '
'Exiting.'.format(
settings.STORAGE_TYPE,
", ".join(acceptable_storage_types)
)
)
self.storage_type = Document.STORAGE_TYPE_UNENCRYPTED
if settings.PASSPHRASE:
self.storage_type = Document.STORAGE_TYPE_GPG
self.stats = {}
self._ignore = []
@@ -209,7 +203,7 @@ class Consumer:
checksum=hashlib.md5(f.read()).hexdigest(),
created=created,
modified=created,
storage_type=settings.STORAGE_TYPE
storage_type=self.storage_type
)
relevant_tags = set(list(Tag.match_all(text)) + list(file_info.tags))
@@ -231,7 +225,7 @@ class Consumer:
if document.storage_type == Document.STORAGE_TYPE_UNENCRYPTED:
write_file.write(read_file.read())
return
self.log("debug", "Encrypting the thumbnail")
self.log("debug", "Encrypting")
write_file.write(GnuPG.encrypted(read_file))
def _cleanup_doc(self, doc):

10
src/manage.py
View File

@@ -6,16 +6,6 @@ if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "paperless.settings")
from django.conf import settings
from django.core.management import execute_from_command_line
# The runserver and consumer need to have access to the passphrase, so it
# must be entered at start time to keep it safe.
if "runserver" in sys.argv or "document_consumer" in sys.argv:
if not settings.STORAGE_TYPE == "unencrypted":
while not settings.PASSPHRASE:
settings.PASSPHRASE = input(
"settings.PASSPHRASE is unset. Input passphrase: "
)
execute_from_command_line(sys.argv)

26
src/paperless/settings.py
View File

@@ -251,21 +251,17 @@ CONSUMPTION_DIR = os.getenv("PAPERLESS_CONSUMPTION_DIR")
# slowly, you may want to use a higher value than the default.
CONSUMER_LOOP_TIME = int(os.getenv("PAPERLESS_CONSUMER_LOOP_TIME", 10))
# By default, Paperless will attempt to GPG encrypt your PDF files using the
# PASSPHRASE specified below. If however you're not concerned about encrypting
# these files (for example if you have disk encryption locally) then
# you don't need this and can safely turn it off by setting STORAGE_TYPE to
# "unencrypted" here. In such a case, the PASSPHRASE value set below will be
# ignored.
STORAGE_TYPE = os.getenv("PAPERLESS_STORAGE_TYPE", "gpg")
# This is used to encrypt the original documents and decrypt them later when
# you want to download them. Set it and change the permissions on this file to
# 0600, or set it to `None` and you'll be prompted for the passphrase at
# runtime. The default looks for an environment variable.
# DON'T FORGET TO SET THIS as leaving it blank may cause some strange things
# with GPG, including an interesting case where it may "encrypt" zero-byte
# files.
# Pre-2.x versions of Paperless stored your documents locally with GPG
# encryption, but that is no longer the default. This behaviour is still
# available, but it must be explicitly enabled by setting
# `PAPERLESS_PASSPHRASE` in your environment or config file. The default is to
# store these files unencrypted.
#
# Translation:
# * If you're a new user, you can safely ignore this setting.
# * If you're upgrading from 1.x, this must be set, OR you can run
# `./manage.py change_storage_type gpg unencrypted` to decrypt your files,
# after which you can unset this value.
PASSPHRASE = os.getenv("PAPERLESS_PASSPHRASE")
# Trigger a script after every successful document consumption?