From 76a9827958171743a838cf04a7107a661b821928 Mon Sep 17 00:00:00 2001 From: stgarf Date: Sat, 16 Feb 2019 23:25:40 -0800 Subject: [PATCH 1/5] Add docs about enabling and disabling encryption Adding docs outlining basic syntax of enabling and disabling encryption of your paperless document installation. --- docs/utilities.rst | 59 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/utilities.rst b/docs/utilities.rst index f0ab76d26..26622ea41 100644 --- 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 From aed8d6ae41282b4b573dfad6d47dce5d22a15f5d Mon Sep 17 00:00:00 2001 From: Steve Garf Date: Sun, 3 Mar 2019 10:31:50 -0800 Subject: [PATCH 2/5] Fix missing . in underline --- docs/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 26622ea41..cc4d457bb 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -266,7 +266,7 @@ Basic usage to enable encryption of your document store (**USE A MORE SECURE PAS Disabling Encryption -................... +.................... Basic usage to enable encryption of your document store From 14d7adbd0a873fca7e56f2d5f5a89621bb995fc5 Mon Sep 17 00:00:00 2001 From: Pit Date: Sun, 3 Mar 2019 10:45:58 -0800 Subject: [PATCH 3/5] Update docs/utilities.rst Co-Authored-By: stgarf --- docs/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index cc4d457bb..93d156f61 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -258,7 +258,7 @@ 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) +(Note: If ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here) .. code:: bash From 44878f28fac894960cf3e03b3c520e2b4b61271b Mon Sep 17 00:00:00 2001 From: Pit Date: Sun, 3 Mar 2019 10:46:06 -0800 Subject: [PATCH 4/5] Update docs/utilities.rst Co-Authored-By: stgarf --- docs/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 93d156f61..4a590fd39 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -270,7 +270,7 @@ 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) +(Note: Again, if ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here) .. code:: bash From 7bf1d2883c2a97e02987e49951f5a59d55960c59 Mon Sep 17 00:00:00 2001 From: Pit Date: Sun, 3 Mar 2019 10:46:43 -0800 Subject: [PATCH 5/5] Update docs/utilities.rst Co-Authored-By: stgarf --- docs/utilities.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/utilities.rst b/docs/utilities.rst index 4a590fd39..e95ef4725 100644 --- a/docs/utilities.rst +++ b/docs/utilities.rst @@ -268,7 +268,7 @@ Basic usage to enable encryption of your document store (**USE A MORE SECURE PAS Disabling Encryption .................... -Basic usage to enable encryption of your document store +Basic usage to enable encryption of your document store: (Note: Again, if ``PAPERLESS_PASSPHRASE`` isn't set already, you need to specify it here)