[hop] branch release2.1.0 updated: Update pgpencryptfiles.adoc

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hansva pushed a commit to branch release2.1.0
in repository https://gitbox.apache.org/repos/asf/hop.git


The following commit(s) were added to refs/heads/release2.1.0 by this push:
     new cd18ac0891 Update pgpencryptfiles.adoc
     new 9ab39efd0a Merge pull request #1782 from iavasquez/patch-1
cd18ac0891 is described below

commit cd18ac0891fa387374aae04015fa6d5b3eb99250
Author: iavasquez <ia...@users.noreply.github.com>
AuthorDate: Thu Nov 10 08:29:58 2022 -0700

    Update pgpencryptfiles.adoc
    
    Clarifying the requirements of the GnuPG package for this to function
---
 .../modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc      | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
index 61f53af315..6711cc2504 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pgpencryptfiles.adoc
@@ -22,7 +22,9 @@ under the License.
 
 == Description
 
-The Encrypt Files With PGP action can be used to encrypt and sign files.
+The Encrypt Files With PGP action can be used to encrypt and sign files using the GnuPG package.
+
+GnuPG package must be installed in the runtime environment and encryption keys added to the runtime user keystore for this to function.
 
 == Options
 
@@ -34,7 +36,7 @@ The Encrypt Files With PGP action can be used to encrypt and sign files.
 |Workflow action name|The name of the workflow action.
 *Note*: This name has to be unique in a single workflow.
 A workflow action can be placed several times on the canvas, however it will be the same workflow action.
-|GPG location|The signature file path.
+|GPG location|The file path of the GnuPG executable (e.g. /usr/bin/gpg).
 |Use ASCII mode|Whether or not to use ASCII mode when encrypting.
 |Include subfolders|Whether or not to include subfolders.
 |Copy previous results to args|
@@ -42,7 +44,7 @@ A workflow action can be placed several times on the canvas, however it will be
 |File/Folder source|The file to encrypt, can be added to the Files/Folders list using Add.
 |File/Folder destination|The destination of the encrypted files.
 |Wildcard|A regex wildcard.
-|User ID|
+|User ID|User ID of the key in the runtime user keystore
 |Files/Folders|The files to encrypt.
 |===