paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-09 09:58:20 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
Jonas Winkler 2020-11-17 18:11:53 +01:00
parent 43b5d61483
commit e05f5fd583
4 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/_static/recommended_workflow.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 67 KiB

10
docs/administration.rst
View File

@ -294,10 +294,14 @@ Documents can be stored in Paperless using GnuPG encryption.
.. danger:: .. danger::
Decryption is depreceated since paperless-ng 1.0 and doesn't really provide any Decryption is depreceated since paperless-ng 0.9 and doesn't really provide any
additional security, since you have to store the passphrase in a configuration additional security, since you have to store the passphrase in a configuration
file on the same system as the encrypted documents for paperless to work. Also, file on the same system as the encrypted documents for paperless to work.
paperless provides transparent access to your encrypted documents. Furthermore, the entire text content of the documents is stored plain in the
database, even if your documents are encrypted. Filenames are not encrypted as
well.
Also, the web server provides transparent access to your encrypted documents.
Consider running paperless on an encrypted filesystem instead, which will then Consider running paperless on an encrypted filesystem instead, which will then
at least provide security against physical hardware theft. at least provide security against physical hardware theft.

8
docs/changelog.rst
View File

@ -8,10 +8,8 @@ Changelog
paperless-ng 0.9.0 paperless-ng 0.9.0
################## ##################
* **Deprecated:** GnuPG. Don't use it. If you're still using it, be aware that it * **Deprecated:** GnuPG. :ref:`See this note on the state of GnuPG in paperless-ng. <utilities-encyption>`
offers no protection at all, since the passphrase is stored alongside with the This features will most likely be removed in future versions.
encrypted documents itself. This features will most likely be removed in future
versions.
* **Added:** New frontend. Features: * **Added:** New frontend. Features:
@ -91,7 +89,7 @@ paperless-ng 0.9.0
* The presence of ``PAPERLESS_DBHOST`` now determines whether to use PostgreSQL or * The presence of ``PAPERLESS_DBHOST`` now determines whether to use PostgreSQL or
sqlite. sqlite.
* ``PAPERLESS_OCR_THREADS`` is gone and replaced with ``PAPERLESS_TASK_WORKERS`` and * ``PAPERLESS_OCR_THREADS`` is gone and replaced with ``PAPERLESS_TASK_WORKERS`` and
``PAPERLESS_THREADS_PER_WORKER``. See TODO for details. ``PAPERLESS_THREADS_PER_WORKER``. Refer to the config example for details.
* Many more small changes here and there. The usual stuff. * Many more small changes here and there. The usual stuff.

5
docs/usage_overview.rst
View File

@ -136,6 +136,7 @@ REST API
You can also submit a document using the REST API, see :ref:`api-file_uploads` for details. You can also submit a document using the REST API, see :ref:`api-file_uploads` for details.
.. _usage-recommended_workflow: .. _usage-recommended_workflow:
The recommended workflow The recommended workflow
@ -147,6 +148,10 @@ is as follows. This workflow also takes into account that some documents
have to be kept in physical form, but still ensures that you get all the have to be kept in physical form, but still ensures that you get all the
advantages for these documents as well. advantages for these documents as well.
The following diagram shows how easy it is to manage your documents.
.. image:: _static/recommended_workflow.png
Preparations in paperless Preparations in paperless
========================= =========================