[incubator-hop-docs] branch asf-site updated: Documentation updated to 1bf239d

[gi...@apache.org]

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

git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new 63bb4d9  Documentation updated to 1bf239d
63bb4d9 is described below

commit 63bb4d9281170e3b710606cac05621ca79f7ac3f
Author: jenkins <bu...@apache.org>
AuthorDate: Sat Mar 13 14:10:55 2021 +0000

    Documentation updated to 1bf239d
---
 .../ROOT/pages/plugins/passwords/aespasswords.adoc | 62 ++++++++++++++++++++++
 .../workflow/actions/deleteresultfilenames.adoc    |  6 +--
 2 files changed, 65 insertions(+), 3 deletions(-)

diff --git a/hop-user-manual/modules/ROOT/pages/plugins/passwords/aespasswords.adoc b/hop-user-manual/modules/ROOT/pages/plugins/passwords/aespasswords.adoc
new file mode 100644
index 0000000..1ac53ec
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/plugins/passwords/aespasswords.adoc
@@ -0,0 +1,62 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements.  See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership.  The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License.  You may obtain a copy of the License at
+  http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+:documentationPath: /plugins/passwords/
+:language: en_US
+:page-alternativeEditUrl: https://github.com/apache/incubator-hop/edit/master/plugins/misc/passwords/src/main/doc/aespasswords.adoc
+= AES Two way password encoder
+
+== Description
+
+The AES two-way password encoder plugin allows you to encrypt and decrypt passwords using a provided key string.
+
+== Configuration
+
+The configuration of this encoder is for the whole Hop environment and can as such only be done using system properties.  You can specify those at runtime with hop-run or in the hop-config.json file.
+
+* *HOP_PASSWORD_ENCODER_PLUGIN* : set this to the ID of this plugin: AES
+* *HOP_AES_ENCODER_KEY* : Specify the key to use to encode or decode passwords
+
+== Noteworthy
+
+Please note that passwords are encoded with prefix ```AES ``` which is AES plus a space.
+This means that it's different from standard, Hop encoded, passwords which have prefix ```Encrypted ``` which is Encrypted plus a space.
+The consequence of this is that you need to encode passwords either one way or another.  Mixing password encoding is not supported.
+
+== Best practices
+
+Make sure to only use variables and parameters to specify passwords.
+Store the passwords in an environment using the projects plugin.  This way you can store the passwords in a single file specific for the given environment (development, test, production, ...).
+
+Secure the passwords file.  Even though passwords are encrypted it's better to be safe than sorry.  A password that can't be read, encrypted or otherwise, can't be seen in any way.  So use appropriate file security on the file in which you eventually store the passwords.  This advice is doubly true for the key.
+
+You can specify the key using a variable as well.
+
+== Hop Encrypt
+
+You can test your setup by setting the variables in your environment and then by using hop-encrypt to see the output:
+
+[source,bash]
+----
+$:~/hop$ export HOP_PASSWORD_ENCODER_PLUGIN=AES
+$:~/hop$ export HOP_AES_ENCODER_KEY=ddsfsdfsfsdf
+$:~/hop$ sh hop-encrypt.sh -hop MyPassword222
+AES kb/8yIPqClL/0+/e+gsVcw==
+
+$:~/hop$ export HOP_AES_ENCODER_KEY=abcd
+$:~/hop$ sh hop-encrypt.sh -hop MyPassword222
+AES s7JDgDBqQWMh1E/RWgGaUA==
+----
diff --git a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
index 007bfb4..1998da3 100644
--- a/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
+++ b/hop-user-manual/modules/ROOT/pages/workflow/actions/deleteresultfilenames.adoc
@@ -28,8 +28,8 @@ Use this action to delete all the filenames that are in the result files list of
 [width="90%", options="header"]
 |===
 |Option|Description
-|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.
-|Limit action to| Enable this feature if you want to limit the deletion to certain filenames in the result file list.
+|Workflow action name|The name of the workflow action.
+|Limit action to|Enable this feature if you want to limit the deletion to certain filenames in the result file list.
 |Wildcard|The regular expression to limit the files to delete
-|Exclude wildcar|The regular expression to exclude certain files from being deleted.
+|Exclude wildcard|The regular expression to exclude certain files from being deleted. 
 |===
\ No newline at end of file