[GitHub] [nifi] exceptionfactory commented on a change in pull request #5511: NIFI-9367 Update README.md

[GitBox <gi...@apache.org>]

exceptionfactory commented on a change in pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#discussion_r744739089



##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):

Review comment:
       Recommend adjusting the wording as follows, similar to the main project README:
   
   ```suggestion
   The default configuration generates a random username and password on startup. NiFi writes the generated credentials to the application log.
   
   The following command can be used to find the generated credentials on operating systems with grep installed:
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -86,7 +94,7 @@ Environment variables can be used to set the NiFi communication ports and hostna
       -e NIFI_WEB_HTTPS_PORT='9443' \
       apache/nifi:latest
 
-Single User Authentication credentials can be specified using environment variables as follows:
+The esiest way to run NiFi is probably with specifying Single User Authentication credentials using environment variables as follows:

Review comment:
       Recommend reverting this change as the existing wording is already clear.
   

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):
+
+    docker logs nifi | grep Generated
+
+the credentials will then be displayed such as
+
+    Generated Username [5ae5ed8e-b695-4589-bfb0-aee8989a08b3]
+    Generated Password [YJZD3kP8SFzF+SbRmHlcTBifiZTvS6bb]

Review comment:
       ```suggestion
       Generated Username [USERNAME]
       Generated Password [PASSWORD]
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -95,6 +103,7 @@ Single User Authentication credentials can be specified using environment variab
       -e SINGLE_USER_CREDENTIALS_PASSWORD=ctsBtRBKHRAx69EqUghvvgEvjnaLjFEB \
       apache/nifi:latest
 
+Please note that the password must be 12 chars minimmum, or a new one will be generated (see above to find it in the logs)

Review comment:
       The wording should be adjusted to correct the spelling of `minimum`, and spelling out `characters` would be helpful.
   ```suggestion
   Please note that the password must be 12 characters minimum, otherwise NiFi will generate a random username and password.
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):
+
+    docker logs nifi | grep Generated
+
+the credentials will then be displayed such as

Review comment:
       Following the project README:
   ```suggestion
   NiFi logs the generated credentials as follows:
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org