Merge branch 'master' into master

docs/changelog.rst

@@ -627,117 +627,117 @@ bulk of the work on this big change.
 .. _Colin Frei: https://github.com/colinfrei
 .. _khrise: https://github.com/khrise
 .. _syntonym: https://github.com/syntonym
-.. _JOKer: https://github.com/JOKer
+.. _JOKer: https://github.com/MasterofJOKers
 .. _Brian Cribbs: https://github.com/cribbstechnolog
 .. _Brendan M. Sleight: https://github.com/bmsleight
 
-.. _#20: https://github.com/danielquinn/paperless/issues/20
-.. _#44: https://github.com/danielquinn/paperless/issues/44
-.. _#45: https://github.com/danielquinn/paperless/issues/45
-.. _#47: https://github.com/danielquinn/paperless/issues/47
-.. _#48: https://github.com/danielquinn/paperless/issues/48
-.. _#53: https://github.com/danielquinn/paperless/issues/53
-.. _#54: https://github.com/danielquinn/paperless/issues/54
-.. _#57: https://github.com/danielquinn/paperless/issues/57
-.. _#60: https://github.com/danielquinn/paperless/issues/60
-.. _#67: https://github.com/danielquinn/paperless/issues/67
-.. _#68: https://github.com/danielquinn/paperless/issues/68
-.. _#71: https://github.com/danielquinn/paperless/issues/71
-.. _#81: https://github.com/danielquinn/paperless/issues/81
-.. _#89: https://github.com/danielquinn/paperless/issues/89
-.. _#94: https://github.com/danielquinn/paperless/issues/94
-.. _#98: https://github.com/danielquinn/paperless/issues/98
-.. _#112: https://github.com/danielquinn/paperless/issues/112
-.. _#121: https://github.com/danielquinn/paperless/issues/121
-.. _#131: https://github.com/danielquinn/paperless/issues/131
-.. _#146: https://github.com/danielquinn/paperless/issues/146
-.. _#148: https://github.com/danielquinn/paperless/pull/148
-.. _#150: https://github.com/danielquinn/paperless/pull/150
-.. _#158: https://github.com/danielquinn/paperless/issues/158
-.. _#171: https://github.com/danielquinn/paperless/issues/171
-.. _#172: https://github.com/danielquinn/paperless/issues/172
-.. _#179: https://github.com/danielquinn/paperless/pull/179
-.. _#199: https://github.com/danielquinn/paperless/issues/199
-.. _#200: https://github.com/danielquinn/paperless/issues/200
-.. _#206: https://github.com/danielquinn/paperless/issues/206
-.. _#212: https://github.com/danielquinn/paperless/pull/212
-.. _#220: https://github.com/danielquinn/paperless/pull/220
-.. _#224: https://github.com/danielquinn/paperless/pull/224
-.. _#226: https://github.com/danielquinn/paperless/pull/226
-.. _#227: https://github.com/danielquinn/paperless/pull/227
-.. _#228: https://github.com/danielquinn/paperless/pull/228
-.. _#229: https://github.com/danielquinn/paperless/pull/229
-.. _#230: https://github.com/danielquinn/paperless/pull/230
-.. _#232: https://github.com/danielquinn/paperless/issues/232
-.. _#235: https://github.com/danielquinn/paperless/issues/235
-.. _#236: https://github.com/danielquinn/paperless/issues/236
-.. _#255: https://github.com/danielquinn/paperless/pull/255
-.. _#268: https://github.com/danielquinn/paperless/pull/268
-.. _#277: https://github.com/danielquinn/paperless/pull/277
-.. _#272: https://github.com/danielquinn/paperless/issues/272
-.. _#248: https://github.com/danielquinn/paperless/issues/248
-.. _#278: https://github.com/danielquinn/paperless/issues/248
-.. _#283: https://github.com/danielquinn/paperless/issues/283
-.. _#256: https://github.com/danielquinn/paperless/pull/256
-.. _#285: https://github.com/danielquinn/paperless/pull/285
-.. _#291: https://github.com/danielquinn/paperless/pull/291
-.. _#295: https://github.com/danielquinn/paperless/pull/295
-.. _#299: https://github.com/danielquinn/paperless/issues/299
-.. _#300: https://github.com/danielquinn/paperless/pull/300
-.. _#301: https://github.com/danielquinn/paperless/issues/301
-.. _#303: https://github.com/danielquinn/paperless/issues/303
-.. _#305: https://github.com/danielquinn/paperless/issues/305
-.. _#306: https://github.com/danielquinn/paperless/issues/306
-.. _#308: https://github.com/danielquinn/paperless/issues/308
-.. _#311: https://github.com/danielquinn/paperless/pull/311
-.. _#312: https://github.com/danielquinn/paperless/pull/312
-.. _#313: https://github.com/danielquinn/paperless/pull/313
-.. _#322: https://github.com/danielquinn/paperless/pull/322
-.. _#328: https://github.com/danielquinn/paperless/pull/328
-.. _#253: https://github.com/danielquinn/paperless/issues/253
-.. _#262: https://github.com/danielquinn/paperless/issues/262
-.. _#323: https://github.com/danielquinn/paperless/issues/323
-.. _#344: https://github.com/danielquinn/paperless/pull/344
-.. _#351: https://github.com/danielquinn/paperless/pull/351
-.. _#352: https://github.com/danielquinn/paperless/pull/352
-.. _#354: https://github.com/danielquinn/paperless/issues/354
-.. _#371: https://github.com/danielquinn/paperless/issues/371
-.. _#374: https://github.com/danielquinn/paperless/pull/374
-.. _#375: https://github.com/danielquinn/paperless/pull/375
-.. _#376: https://github.com/danielquinn/paperless/pull/376
-.. _#383: https://github.com/danielquinn/paperless/pull/383
-.. _#384: https://github.com/danielquinn/paperless/issues/384
-.. _#386: https://github.com/danielquinn/paperless/issues/386
-.. _#387: https://github.com/danielquinn/paperless/pull/387
-.. _#391: https://github.com/danielquinn/paperless/pull/391
-.. _#390: https://github.com/danielquinn/paperless/pull/390
-.. _#392: https://github.com/danielquinn/paperless/issues/392
-.. _#393: https://github.com/danielquinn/paperless/issues/393
-.. _#395: https://github.com/danielquinn/paperless/pull/395
-.. _#394: https://github.com/danielquinn/paperless/issues/394
-.. _#396: https://github.com/danielquinn/paperless/pull/396
-.. _#399: https://github.com/danielquinn/paperless/pull/399
-.. _#400: https://github.com/danielquinn/paperless/pull/400
-.. _#401: https://github.com/danielquinn/paperless/pull/401
-.. _#405: https://github.com/danielquinn/paperless/pull/405
-.. _#406: https://github.com/danielquinn/paperless/issues/406
-.. _#412: https://github.com/danielquinn/paperless/issues/412
-.. _#413: https://github.com/danielquinn/paperless/pull/413
-.. _#414: https://github.com/danielquinn/paperless/issues/414
-.. _#423: https://github.com/danielquinn/paperless/issues/423
-.. _#433: https://github.com/danielquinn/paperless/issues/433
-.. _#440: https://github.com/danielquinn/paperless/pull/440
-.. _#441: https://github.com/danielquinn/paperless/pull/441
-.. _#442: https://github.com/danielquinn/paperless/pull/442
-.. _#466: https://github.com/danielquinn/paperless/pull/466
-.. _#471: https://github.com/danielquinn/paperless/pull/471
-.. _#475: https://github.com/danielquinn/paperless/pull/475
-.. _#481: https://github.com/danielquinn/paperless/pull/481
-.. _#483: https://github.com/danielquinn/paperless/pull/483
-.. _#484: https://github.com/danielquinn/paperless/pull/484
-.. _#488: https://github.com/danielquinn/paperless/pull/488
-.. _#489: https://github.com/danielquinn/paperless/pull/489
-.. _#492: https://github.com/danielquinn/paperless/pull/492
+.. _#20: https://github.com/the-paperless-project/paperless/issues/20
+.. _#44: https://github.com/the-paperless-project/paperless/issues/44
+.. _#45: https://github.com/the-paperless-project/paperless/issues/45
+.. _#47: https://github.com/the-paperless-project/paperless/issues/47
+.. _#48: https://github.com/the-paperless-project/paperless/issues/48
+.. _#53: https://github.com/the-paperless-project/paperless/issues/53
+.. _#54: https://github.com/the-paperless-project/paperless/issues/54
+.. _#57: https://github.com/the-paperless-project/paperless/issues/57
+.. _#60: https://github.com/the-paperless-project/paperless/issues/60
+.. _#67: https://github.com/the-paperless-project/paperless/issues/67
+.. _#68: https://github.com/the-paperless-project/paperless/issues/68
+.. _#71: https://github.com/the-paperless-project/paperless/issues/71
+.. _#81: https://github.com/the-paperless-project/paperless/issues/81
+.. _#89: https://github.com/the-paperless-project/paperless/issues/89
+.. _#94: https://github.com/the-paperless-project/paperless/issues/94
+.. _#98: https://github.com/the-paperless-project/paperless/issues/98
+.. _#112: https://github.com/the-paperless-project/paperless/issues/112
+.. _#121: https://github.com/the-paperless-project/paperless/issues/121
+.. _#131: https://github.com/the-paperless-project/paperless/issues/131
+.. _#146: https://github.com/the-paperless-project/paperless/issues/146
+.. _#148: https://github.com/the-paperless-project/paperless/pull/148
+.. _#150: https://github.com/the-paperless-project/paperless/pull/150
+.. _#158: https://github.com/the-paperless-project/paperless/issues/158
+.. _#171: https://github.com/the-paperless-project/paperless/issues/171
+.. _#172: https://github.com/the-paperless-project/paperless/issues/172
+.. _#179: https://github.com/the-paperless-project/paperless/pull/179
+.. _#199: https://github.com/the-paperless-project/paperless/issues/199
+.. _#200: https://github.com/the-paperless-project/paperless/issues/200
+.. _#206: https://github.com/the-paperless-project/paperless/issues/206
+.. _#212: https://github.com/the-paperless-project/paperless/pull/212
+.. _#220: https://github.com/the-paperless-project/paperless/pull/220
+.. _#224: https://github.com/the-paperless-project/paperless/pull/224
+.. _#226: https://github.com/the-paperless-project/paperless/pull/226
+.. _#227: https://github.com/the-paperless-project/paperless/pull/227
+.. _#228: https://github.com/the-paperless-project/paperless/pull/228
+.. _#229: https://github.com/the-paperless-project/paperless/pull/229
+.. _#230: https://github.com/the-paperless-project/paperless/pull/230
+.. _#232: https://github.com/the-paperless-project/paperless/issues/232
+.. _#235: https://github.com/the-paperless-project/paperless/issues/235
+.. _#236: https://github.com/the-paperless-project/paperless/issues/236
+.. _#255: https://github.com/the-paperless-project/paperless/pull/255
+.. _#268: https://github.com/the-paperless-project/paperless/pull/268
+.. _#277: https://github.com/the-paperless-project/paperless/pull/277
+.. _#272: https://github.com/the-paperless-project/paperless/issues/272
+.. _#248: https://github.com/the-paperless-project/paperless/issues/248
+.. _#278: https://github.com/the-paperless-project/paperless/issues/248
+.. _#283: https://github.com/the-paperless-project/paperless/issues/283
+.. _#256: https://github.com/the-paperless-project/paperless/pull/256
+.. _#285: https://github.com/the-paperless-project/paperless/pull/285
+.. _#291: https://github.com/the-paperless-project/paperless/pull/291
+.. _#295: https://github.com/the-paperless-project/paperless/pull/295
+.. _#299: https://github.com/the-paperless-project/paperless/issues/299
+.. _#300: https://github.com/the-paperless-project/paperless/pull/300
+.. _#301: https://github.com/the-paperless-project/paperless/issues/301
+.. _#303: https://github.com/the-paperless-project/paperless/issues/303
+.. _#305: https://github.com/the-paperless-project/paperless/issues/305
+.. _#306: https://github.com/the-paperless-project/paperless/issues/306
+.. _#308: https://github.com/the-paperless-project/paperless/issues/308
+.. _#311: https://github.com/the-paperless-project/paperless/pull/311
+.. _#312: https://github.com/the-paperless-project/paperless/pull/312
+.. _#313: https://github.com/the-paperless-project/paperless/pull/313
+.. _#322: https://github.com/the-paperless-project/paperless/pull/322
+.. _#328: https://github.com/the-paperless-project/paperless/pull/328
+.. _#253: https://github.com/the-paperless-project/paperless/issues/253
+.. _#262: https://github.com/the-paperless-project/paperless/issues/262
+.. _#323: https://github.com/the-paperless-project/paperless/issues/323
+.. _#344: https://github.com/the-paperless-project/paperless/pull/344
+.. _#351: https://github.com/the-paperless-project/paperless/pull/351
+.. _#352: https://github.com/the-paperless-project/paperless/pull/352
+.. _#354: https://github.com/the-paperless-project/paperless/issues/354
+.. _#371: https://github.com/the-paperless-project/paperless/issues/371
+.. _#374: https://github.com/the-paperless-project/paperless/pull/374
+.. _#375: https://github.com/the-paperless-project/paperless/pull/375
+.. _#376: https://github.com/the-paperless-project/paperless/pull/376
+.. _#383: https://github.com/the-paperless-project/paperless/pull/383
+.. _#384: https://github.com/the-paperless-project/paperless/issues/384
+.. _#386: https://github.com/the-paperless-project/paperless/issues/386
+.. _#387: https://github.com/the-paperless-project/paperless/pull/387
+.. _#391: https://github.com/the-paperless-project/paperless/pull/391
+.. _#390: https://github.com/the-paperless-project/paperless/pull/390
+.. _#392: https://github.com/the-paperless-project/paperless/issues/392
+.. _#393: https://github.com/the-paperless-project/paperless/issues/393
+.. _#395: https://github.com/the-paperless-project/paperless/pull/395
+.. _#394: https://github.com/the-paperless-project/paperless/issues/394
+.. _#396: https://github.com/the-paperless-project/paperless/pull/396
+.. _#399: https://github.com/the-paperless-project/paperless/pull/399
+.. _#400: https://github.com/the-paperless-project/paperless/pull/400
+.. _#401: https://github.com/the-paperless-project/paperless/pull/401
+.. _#405: https://github.com/the-paperless-project/paperless/pull/405
+.. _#406: https://github.com/the-paperless-project/paperless/issues/406
+.. _#412: https://github.com/the-paperless-project/paperless/issues/412
+.. _#413: https://github.com/the-paperless-project/paperless/pull/413
+.. _#414: https://github.com/the-paperless-project/paperless/issues/414
+.. _#423: https://github.com/the-paperless-project/paperless/issues/423
+.. _#433: https://github.com/the-paperless-project/paperless/issues/433
+.. _#440: https://github.com/the-paperless-project/paperless/pull/440
+.. _#441: https://github.com/the-paperless-project/paperless/pull/441
+.. _#442: https://github.com/the-paperless-project/paperless/pull/442
+.. _#466: https://github.com/the-paperless-project/paperless/pull/466
+.. _#471: https://github.com/the-paperless-project/paperless/pull/471
+.. _#475: https://github.com/the-paperless-project/paperless/pull/475
+.. _#481: https://github.com/the-paperless-project/paperless/pull/481
+.. _#483: https://github.com/the-paperless-project/paperless/pull/483
+.. _#484: https://github.com/the-paperless-project/paperless/pull/484
+.. _#488: https://github.com/the-paperless-project/paperless/pull/488
+.. _#489: https://github.com/the-paperless-project/paperless/pull/489
+.. _#492: https://github.com/the-paperless-project/paperless/pull/492
 
 .. _pipenv: https://docs.pipenv.org/
 .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/

docs/contributing.rst

@@ -136,6 +136,6 @@ there, with a few small changes, but basically it boils down to:
 I'm proud to say that the CoC has never had to be enforced because everyone has
 been awesome, friendly, and professional.
 
-.. _GitHub: https://github.com/danielquinn/paperless/issues
+.. _GitHub: https://github.com/the-paperless-project/paperless/issues
 .. _very well documented: https://www.python.org/dev/peps/pep-0008/
-.. _code of conduct: https://github.com/danielquinn/paperless/blob/master/CODE_OF_CONDUCT.md
+.. _code of conduct: https://github.com/the-paperless-project/paperless/blob/master/CODE_OF_CONDUCT.md

docs/extending.rst

@@ -8,7 +8,7 @@ managed by way of modifying the code directly and issuing a pull request on
 `GitHub`_.  However, over time the project has been evolving to be a little
 more "pluggable" so that users can write their own stuff that talks to it.
 
-.. _GitHub: https://github.com/danielquinn/paperless
+.. _GitHub: https://github.com/the-paperless-project/paperless
 
 
 .. _extending-parsers:
@@ -106,7 +106,7 @@ The core Paperless functionality is based on this design, so if you want to see
 what a parser module should look like, have a look at `parsers.py`_,
 `signals.py`_, and `apps.py`_ in the `paperless_tesseract`_ module.
 
-.. _parsers.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/parsers.py
-.. _signals.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/signals.py
-.. _apps.py: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/apps.py
-.. _paperless_tesseract: https://github.com/danielquinn/paperless/blob/master/src/paperless_tesseract/
+.. _parsers.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/parsers.py
+.. _signals.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/signals.py
+.. _apps.py: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/apps.py
+.. _paperless_tesseract: https://github.com/the-paperless-project/paperless/blob/master/src/paperless_tesseract/

docs/requirements.rst

@@ -52,7 +52,7 @@ with PDFs.  Often this is the case with Apple systems using HomeBrew, but other
 Linuxes have been a problem as well.  The solution appears to be to install
 ghostscript as well as ImageMagick:
 
-.. _run into problems: https://github.com/danielquinn/paperless/issues/25
+.. _run into problems: https://github.com/the-paperless-project/paperless/issues/25
 
 .. code:: bash
 
@@ -92,7 +92,7 @@ enter it, and install the requirements using the ``requirements.txt`` file:
     $ . /path/to/arbitrary/directory/bin/activate
     $ pip install  --requirement /path/to/paperless/requirements.txt
 
-Now you're ready to go.  Just remember to enter (activate) your virtualenv 
+Now you're ready to go.  Just remember to enter (activate) your virtualenv
 whenever you want to use Paperless.
 
 

docs/setup.rst

@@ -8,7 +8,7 @@ basic documentation is in order.  If you follow along in this document and
 still have trouble, please open an `issue on GitHub`_ so I can fill in the
 gaps.
 
-.. _issue on GitHub: https://github.com/danielquinn/paperless/issues
+.. _issue on GitHub: https://github.com/the-paperless-project/paperless/issues
 
 
 .. _setup-download:
@@ -21,7 +21,7 @@ either by using ``git``:
 
 .. code:: bash
 
-    $ git clone https://github.com/danielquinn/paperless.git
+    $ git clone https://github.com/the-paperless-project/paperless.git
     $ cd paperless
 
 or just download the tarball and go that route:
@@ -29,7 +29,7 @@ or just download the tarball and go that route:
 .. code:: bash
 
     $ cd to the directory where you want to run Paperless
-    $ wget https://github.com/danielquinn/paperless/archive/master.zip
+    $ wget https://github.com/the-paperless-project/paperless/archive/master.zip
     $ unzip master.zip
     $ cd paperless-master
 
@@ -152,15 +152,15 @@ Docker Method
    instructions in comments in the file. The only change that is a hard
    requirement is to specify where the consumption directory should
    mount.[#dockercomposeyml]_
-	 
+
 	 .. caution::
-	 
+
 	     If you are using NFS mounts for the consume directory you also need to
 			 change the command to turn off inotify as it doesn't work with NFS
-			 
+
 			 `command: ["document_consumer", "--no-inotify"]`
-			 
-			 
+
+
 5. Modify ``docker-compose.env`` and adapt the following environment variables:
 
    ``PAPERLESS_PASSPHRASE``

docs/troubleshooting.rst

@@ -72,15 +72,4 @@ with a DPI of 300, then merging the images into the single PDF with
 For more information on this and situations like it, you should take a look
 at `Issue #118`_ as that's where this tip originated.
 
-.. _Issue #118: https://github.com/danielquinn/paperless/issues/118
-
-
-.. _troubleshooting-consumerlogs
-
-
-Viewing Consumer logs
----------------------
-
-.. code:: bash
-
-    $ sudo journalctl -u paperless-consumer
+.. _Issue #118: https://github.com/the-paperless-project/paperless/issues/118

docs/utilities.rst

@@ -216,3 +216,62 @@ That's it.  It'll loop over all of the documents in your database and attempt
 to match all of your tags to them.  If one matches, it'll be applied.  And
 don't worry, you can run this as often as you like, it won't double-tag
 a document.
+
+.. _utilities-encyption:
+
+Enabling Encrpytion
+-------------------
+
+Let's say you've imported a few documents to play around with paperless and now
+you are using it more seriously and want to enable encryption of your files.
+
+.. utilities-encryption-howto:
+
+Basic Syntax
+.............
+
+Again we'll use the ``manage.py`` script, passing ``change_storage_type``:
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py change_storage_type --help
+		usage: manage.py change_storage_type [-h] [--version] [-v {0,1,2,3}]
+                                     [--settings SETTINGS]
+                                     [--pythonpath PYTHONPATH] [--traceback]
+                                     [--no-color] [--passphrase PASSPHRASE]
+                                     {gpg,unencrypted} {gpg,unencrypted}
+
+    This is how you migrate your stored documents from an encrypted state to an
+    unencrypted one (or vice-versa)
+
+    positional arguments:
+      {gpg,unencrypted}     The state you want to change your documents from
+      {gpg,unencrypted}     The state you want to change your documents to
+
+    optional arguments:
+      --passphrase PASSPHRASE
+                            If PAPERLESS_PASSPHRASE isn't set already, you need to
+                            specify it here
+
+Enabling Encryption
+...................
+
+Basic usage to enable encryption of your document store (**USE A MORE SECURE PASSPHRASE**):
+
+(Note: If ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py change_storage_type [--passphrase SECR3TP4SSPHRA$E] unencrypted gpg
+
+
+Disabling Encryption
+....................
+
+Basic usage to enable encryption of your document store:
+
+(Note: Again, if ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)
+
+.. code:: bash
+
+    $ /path/to/paperless/src/manage.py change_storage_type [--passphrase SECR3TP4SSPHRA$E] gpg unencrypted