Merge "Updated the Version of Stating Dockers"

[integration.git] / test / mocks / pnfsimulator / README.md

diff --git a/test/mocks/pnfsimulator/README.md b/test/mocks/pnfsimulator/README.md
index d1f2a0c..24359ae 100644 (file)
--- a/test/mocks/pnfsimulator/README.md
+++ b/test/mocks/pnfsimulator/README.md
@@ -20,7 +20,9 @@ Proper config must contain *simulatorParams*, *commonEventHeaderParams* and *pnf
 The recommended way is to checkout PNF Simulator project from ONAP Git repository and use *simulator*.sh script.
 If you copy *simulator.sh* script to another location, keep in mind to copy also *docker-compose.yml* and directories: *config,json_schema and netconf*.
 In order to run simulator, invoke ./simulator.sh start
+You may be asked for providing password for ypur user during startup.
 Script downloads if necessary needed Docker images and runs instances of these images.
+The easiest way is to download or generate PNF Simulator zip archive with all needed configuration files.
 
 ###Logging
 It is possible to get access to logs by invocation of *./simulator.sh* logs. 
@@ -52,8 +54,14 @@ After that execute *./simulator.sh stop* and when it's finished *./simulator.sh
 In order to connect execute command *ftp -p localhost 2221* and, when requested, provide user and password.
 In order to download a file execute, while still being logged in, *get file-name-to-be-downloaded*.
 
-###FTPES support for vsftpd server
-TBD
+###FTPES support for VSFTPD server
+PNF Simulator allows to serve files via FTPES VSFTPD server. VSFTPD server has predefined user *onap* with password *pano*.
+By default TLS support is enabled. Required certificates and keys are generated via vsftpd_certs_keys_generator.sh and located in ./ftpes/vsftpd/tls/ .
+We can generate our own certificates and keys using that script and passing 'secret' password when you are asked for entering keystore password. In other cases just press ENTER to go on.
+Configuration of VSFTPD server is located in ./ftpes/vsftpd/configuration/vsftpd_ssl.conf .
+Docker-compose contains VSFTPD server image with it's configurations.
+
+In order to verify connection, please use *FileZilla* for testing.
 
 ###Developer mode
 For development of PNF Simulator, run *simulator.sh* start-dev in order to run minimal necessary set of supporting services such as Netopeer of FTP servers.