Merge branch 'master' into dev

2025-07-28 18:24:38 -05:00 · 2019-05-21 13:06:16 +02:00
parent 4bd018df07 8e6d7cba13
commit 32f3876590
35 changed files with 587 additions and 297 deletions
--- a/docs/_static/Screenshot_first_logged.png
+++ b/docs/_static/Screenshot_first_logged.png
--- a/docs/_static/Screenshot_first_run_login.png
+++ b/docs/_static/Screenshot_first_run_login.png
--- a/docs/_static/Screenshot_upload_and_scanned.png
+++ b/docs/_static/Screenshot_upload_and_scanned.png
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -1,6 +1,23 @@
 Changelog
 #########

+2.7.0
+=====
+
+* `syntonym`_ submitted a pull request to catch IMAP connection errors `#475`_.
+* `Stéphane Brunner`_ added ``psycopg2`` to the Pipfile `#489`_.  He also fixed
+  a syntax error in ``docker-compose.yml.example`` `#488`_ and added [DjangoQL](https://github.com/ivelum/djangoql),
+  which allows a litany of handy search functionality `#492`_.
+* `CkuT`_ and `JOKer`_ hacked out a simple, but super-helpful optimisation to
+  how the thumbnails are served up, improving performance considerably `#481`_.
+* `tsia`_ added a few fields to the tags REST API. `#483`_.
+* `Brian Cribbs`_ improved the documentation to help people using Paperless
+  over NFS `#484`_.
+* `Brendan M. Sleight`_ updated the documentation to include a note for setting the
+  ``DEBUG`` value.  The ``paperless.conf.example`` file was also updated to
+  mirror the project defaults.
+
+
 2.6.1
 =====

@@ -10,7 +27,7 @@ Changelog
  that using the push API will work for users of the Docker install.  Thanks to
  `Colin Frei`_ for fixing this in `#466`_.
 * `khrise`_ submitted a pull request to include the ``added`` property to the
-  REST API `#471`.
+  REST API `#471`_.


 2.6.0
@@ -609,107 +626,118 @@ bulk of the work on this big change.
 .. _Sblop: https://github.com/Sblop
 .. _Colin Frei: https://github.com/colinfrei
 .. _khrise: https://github.com/khrise
+.. _syntonym: https://github.com/syntonym
+.. _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
+.. _#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/
--- a/docs/contributing.rst
+++ b/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
--- a/docs/extending.rst
+++ b/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/
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -45,5 +45,6 @@ Contents
   troubleshooting
   contributing
   scanners
+   screenshots
   changelog
   changelog_jonaswinkler
--- a/docs/requirements.rst
+++ b/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.


--- a/docs/scanners.rst
+++ b/docs/scanners.rst
@@ -17,13 +17,17 @@ that works right for you based on recommentations from other Paperless users.
 +---------+----------------+-----+-----+-----+----------------+
 | Brother | `MFC-J6930DW`_ | yes |     |     | `ayounggun`_   |
 +---------+----------------+-----+-----+-----+----------------+
+| Brother | `MFC-J5910DW`_ | yes |     |     | `bmsleight`_   |
+---------+----------------+-----+-----+-----+----------------+
 | Fujitsu | `ix500`_       | yes |     | yes | `eonist`_      |
 +---------+----------------+-----+-----+-----+----------------+

 .. _ADS-1500W: https://www.brother.ca/en/p/ads1500w
 .. _MFC-J6930DW: https://www.brother.ca/en/p/MFCJ6930DW
+.. _MFC-J5910DW: https://www.brother.co.uk/printers/inkjet-printers/mfcj5910dw
 .. _ix500: http://www.fujitsu.com/us/products/computing/peripheral/scanners/scansnap/ix500/

 .. _danielquinn: https://github.com/danielquinn
 .. _ayounggun: https://github.com/ayounggun
+.. _bmsleight: https://github.com/bmsleight
 .. _eonist: https://github.com/eonist
--- a/docs/screenshots.rst
+++ b/docs/screenshots.rst
@@ -0,0 +1,16 @@
+.. _screenshots:
+
+Screenshots
+===========
+
+Once everything is set-up login to paperless using the web front-end
+
+.. image:: ./_static/Screenshot_first_run_login.png 
+
+Nice clean interface
+
+.. image:: ./_static/Screenshot_first_logged.png 
+
+Some documents loaded in via ftp or using the scanners ftp. 
+
+.. image:: ./_static/Screenshot_upload_and_scanned.png 
--- a/docs/setup.rst
+++ b/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

@@ -77,12 +77,16 @@ Standard (Bare Metal)
      encrypt/decrypt the original documents.  Don't worry about defining this
      if you don't want to use encryption (the default).

+   Note also that if you're using the ``runserver`` as mentioned below, you
+   should make sure that PAPERLESS_DEBUG="true" or is just commented out as
+   this is the default.
+
 4. Initialise the SQLite database with ``./manage.py migrate``.
 5. Create a user for your Paperless instance with
   ``./manage.py createsuperuser``. Follow the prompts to create your user.
 6. Start the webserver with ``./manage.py runserver <IP>:<PORT>``.
-   If no specifc IP or port are given, the default is ``127.0.0.1:8000``
-   also known as http://localhost:8000/.
+   If no specific IP or port is given, the default is ``127.0.0.1:8000`` also
+   known as http://localhost:8000/.
   You should now be able to visit your (empty) installation at
   `Paperless webserver`_ or whatever you chose before.  You can login with the
   user/pass you created in #5.
@@ -143,6 +147,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``
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -72,4 +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
+.. _Issue #118: https://github.com/the-paperless-project/paperless/issues/118
--- a/docs/utilities.rst
+++ b/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