Merge pull request #1 from danielquinn/master

rebase to upstream

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,6 +626,10 @@ 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/JOKer
+.. _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
@@ -710,6 +731,13 @@ bulk of the work on this big change.
 .. _#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
 
 .. _pipenv: https://docs.pipenv.org/
 .. _a new home on Docker Hub: https://hub.docker.com/r/danielquinn/paperless/

docs/requirements.rst

@@ -12,6 +12,7 @@ should work) that has the following software installed:
 * `Imagemagick`_ version 6.7.5 or higher
 * `unpaper`_
 * `libpoppler-cpp-dev`_ PDF rendering library
+* `optipng`_
 
 .. _Python3: https://python.org/
 .. _GNU Privacy Guard: https://gnupg.org
@@ -19,6 +20,7 @@ should work) that has the following software installed:
 .. _Imagemagick: http://imagemagick.org/
 .. _unpaper: https://www.flameeyes.eu/projects/unpaper
 .. _libpoppler-cpp-dev: https://poppler.freedesktop.org/
+.. _optipng: http://optipng.sourceforge.net/
 
 Notably, you should confirm how you access your Python3 installation.  Many
 Linux distributions will install Python3 in parallel to Python2, using the

docs/setup.rst

@@ -78,12 +78,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.
@@ -144,6 +148,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``