ml-testing-toolkit 18.13.0

package/documents/User-Guide-CLI.md

@@ -0,0 +1,218 @@
+# Users Guide
+
+## _Mojaloop Testing Toolkit CLI_
+
+### Introduction
+
+The intention of this document is to provide a basic user guide to the **Mojaloop Testing Toolkit CLI**. This easy to use toolkit was designed for both technical and non-technical users, even though the primarily users would likely be Quality Assurance (QA) resources. By following this guide, users will have a better understand of the capabilities and functionality of the cli.
+
+The **Mojaloop Testing Toolkit CLI** was designed for participants that would like to participate in the Mojaloop scheme. Intentionally build as a standard integration testing tool between a _Digital Financial Service Provider (DFSP)_ and the _Mojaloop Switch_ (Hub), to facilitate testing. This tool set can potentially be used by both the DFSP and the _Mojaloop Switch_ to verify the integration between the 2 entities.
+
+For additional back ground information on the Self Testing Toolkit, please see [Mojaloop Testing Toolkit](/documents/Mojaloop-Testing-Toolkit.md). It would be to the particpant's benefit to familiarise themselves with the understanding of the  [Architecture Diagram](/documents/Mojaloop-Testing-Toolkit.md#7-architecture) that explains the various components and related flows.
+
+
+**Table of Contents**
+
+1. [Getting Started](#1-getting-started)
+2. [The Mojaloop Testing Toolkit CLI](#2-the-mojaloop-testing-toolkit)
+
+    2.1. [Help screen](#21-at-first-glance)
+
+    2.2. [Monitoring Mode](#22-monitoring-mode)
+
+    2.3. [Outbound Mode](#23-outbound-mode)
+
+    2.4. [AWS S3 Upload](#24-aws-s3-upload)
+
+    2.5. [Slack Notification](#25-slack-notification)
+
+### 1. Getting Started
+
+To get started, please follow the instructions in the [README](/README.md) document. This document covers the use-cases with the **Mojaloop Simulator**.
+
+### 2. CLI
+
+#### 2.1 Help screen
+
+The help screen allows you to see the usage, possible options and default values
+
+command: 
+
+```
+node src/cli_client/client -h
+```
+
+output:
+
+```
+Usage: client [options]
+
+Options:
+  -v, --version                                             output the version number
+  -c, --config <config>                                     default configuration: {"mode": "outbound", "reportFormat": "json"}
+  -m, --mode <mode>                                         default: "outbound" --- supported modes: "monitoring", "outbound"
+  -u, --base-url <baseUrl>                                  default: "http://localhost:5050"
+  -i, --input-files <inputFiles>                            csv list of json files or directories; required when the mode is "outbound" --- supported formats: "json"
+  -e, --environment-file <environmentFile>                  required when the mode is "outbound" --- supported formats: "json"
+  --report-format <reportFormat>                            default: "json" --- supported formats: "json", "html", "printhtml"
+  --report-auto-filename-enable <reportAutoFilenameEnable>  default: false, if true the file name will be generated by the backend
+  --report-target <reportTarget>                            default: "file://<file_name_genrated_by_backend>"  --- supported targets: "file://path_to_file", "s3://<bucket_name>[/<file_path>]"
+  --slack-webhook-url <slackWebhookUrl>                     default: "Disabled"  --- supported formats: "https://....."
+  -h, --help                                                output usage information
+
+ *** If the option report-target is set to use AWS S3 service, the variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION) should be passed in environment
+```
+
+#### 2.2 Monitoring Mode
+
+The monitoring mode allows you to monitor _incoming_ requests from the **Mojaloop Simulator**.
+
+Example:
+
+command:
+
+```
+node src/cli_client/client -m monitoring
+```
+
+output:
+
+```
+Listening on newLog events...
+2020-05-12T12:23:32.988Z INFO   (15892862129885sy33i)   Request: post /bulkTransfers
+{
+  "request": {
+    "uniqueId": "15892862129885sy33i",
+    "headers": {
+      "content-type": "application/vnd.interoperability.parties+json;version=1.0",
+      "accept": "application/vnd.interoperability.parties+json;version=1.0",
+      "fspiop-source": "testingtoolkitdfsp",
+      "date": "Tue, 12 May 2020 12:23:32 GMT",
+      "user-agent": "axios/0.19.2",
+      "content-length": "256",
+      "host": "localhost:4040",
+      "connection": "close"
+    },
+    "body": {
+      "bulkTransferId": "202137c6-2ca9-429d-b03b-41d5cf19258c",
+      "bulkQuoteId": "8823f09e-728c-4e04-b718-d17a24e55bb0",
+      "payerFsp": "string",
+      "payeeFsp": "string",
+      "expiration": "2020-01-01T10:10:10.000Z",
+      "extensionList": {
+        "extension": [
+          {
+            "key": "string",
+            "value": "string"
+          }
+        ]
+      }
+    }
+  }
+}
+```
+
+You could Send Transfer from postman or execute outbound mode with an example from examples/test-cases folder
+
+#### 2.3 Outbound Mode
+
+This sections will enable you to intiate requests from the cli to your DFSP implementation.
+
+The user can create a collection of operations and add a number of assertions to these operations. The assertions can be setup and customized to support your testing requirements and verify both positive and negative requests and responses. 
+
+#### Default values
+
+mode:
+  - outbound
+reportFormat:
+  - json
+reportName:
+  - when reportFormat is json: ${test-name}-${date-now}.json
+  - when reportFormat is html/printhtml format: value is generated by the service responsible for converting the json to the given format
+
+#### Exit codes
+
+The CLI tool is able to return the proper exit codes in case of success and failures. This will enable this tool to use in automation systems (CICD).
+
+  - 0: all assertions passed
+  - 1: there is at least 1 failed assertion
+
+#### Example
+
+command:
+
+```
+node src/cli_client/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --report-format html
+```
+
+output:
+
+```
+Listening on outboundProgress events...
+ ████████████████████████████████████████ 100% | ETA: 0s | 3/3
+--------------------TEST CASES--------------------
+P2P Transfer Happy Path
+        Get party information - GET - /parties/{Type}/{ID} - [8/8]
+        Send quote - POST - /quotes - [11/11]
+        Send transfer - POST - /transfers - [9/9]
+--------------------TEST CASES--------------------
+┌───────────────────────────────────────────────────────┐
+│                        SUMMARY                        │
+├───────────────────────┬───────────────────────────────┤
+│ Total assertions      │ 28                            │
+├───────────────────────┼───────────────────────────────┤
+│ Passed assertions     │ 28                            │
+├───────────────────────┼───────────────────────────────┤
+│ Failed assertions     │ 0                             │
+├───────────────────────┼───────────────────────────────┤
+│ Total requests        │ 3                             │
+├───────────────────────┼───────────────────────────────┤
+│ Total test cases      │ 1                             │
+├───────────────────────┼───────────────────────────────┤
+│ Passed percentage     │ 100.00%                       │
+├───────────────────────┼───────────────────────────────┤
+│ Started time          │ Mon, 01 Jun 2020 14:46:20 GMT │
+├───────────────────────┼───────────────────────────────┤
+│ Completed time        │ Mon, 01 Jun 2020 14:46:21 GMT │
+├───────────────────────┼───────────────────────────────┤
+│ Runtime duration      │ 832 ms                        │
+├───────────────────────┼───────────────────────────────┤
+│ Average response time │ NA                            │
+└───────────────────────┴───────────────────────────────┘
+TTK-Assertion-Report-dfsp-p2p-tests-2020-06-01T14:46:21.303Z.html was generated
+Terminate with exit code 0
+```
+
+You will find a report in the project folder - 'TTK-Assertion-Report-{collection-name}-{ISO-date}.{report-format}'
+
+#### 2.4 AWS S3 Upload
+
+You can choose to upload the generated report to AWS S3 at the end of tests execution.
+
+Use the command line option **'--report-target'** to specify the target in the format `s3://<bucket_name>/<object_key>`
+
+You can use the option **'--report-auto-filename-enable'** to replace the file name specified in the target with an auto generated file name.
+
+To use AWS S3 service, the following environment variables should be set with proper credentials
+- AWS_ACCESS_KEY_ID
+- AWS_SECRET_ACCESS_KEY
+- AWS_REGION
+
+Example Command:
+
+```
+node src/cli_client/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --report-format html --report-auto-filename-enable true --report-target s3://qa-reports-bucket/reports-folder/report-name.html
+```
+
+#### 2.5 Slack Notification
+
+You can choose to notify over a slack channel after a completed tests execution.
+For this, you have to generate your `slack webhook` in slack portal and provide the webhook URL by the command line option **'--slack-webhook-url'**
+
+If the S3 option is also set, then a link to the uploaded report will be sent in the slack notification.
+
+Example Command:
+
+```
+node src/cli_client/client -m outbound -i examples/collections/dfsp/p2p_happy_path.json -e examples/environments/dfsp_local_environment.json --slack-webhook-url=https://hooks.slack.com/services/blablabla...
+```

package/documents/User-Guide-Connection-Manager.md

@@ -0,0 +1,282 @@
+# Users Guide Connection Manager
+
+## _Mojaloop Testing Toolkit_
+
+To incorporate security and authenticity validations between the testing DFSP and the _Mojaloop Switch_, the **Mojaloop Connection Manager** can be activated to integrate with the **Mojaloop Testing Toolkit**. This will allow the incorporation of TLS and JWS Certificates and Key validations as part of the process.
+
+**Table of Contents**
+
+0. [User Guide](/documents/User-Guide.md)
+
+1. [Configure TLS](#11-configure-tls)
+
+2. [Configure JWS](#2-configure-jws)
+
+3. [Enabling TLS and JWS Verification](#3-enabling-tls-and-jws-cerification)
+
+4. [Connection Manager Keys and Certificates](#4-connection-manager-keys-and-certificates)
+
+    4.1 [Certificate Authorities](#41-certificate-authorities)
+
+    4.2 [TSL Client Certificates](#42-tls-client-certificates)
+
+    4.3 [TLS Server Certificates](#43-tls-server-certificates)
+
+    4.4 [JWS Certificates](#44-jws-certificates)
+
+5. [Alternative Set-ups](#5-alternative-set-ups)
+
+### 1 Configure TLS
+
+This section will guide you in the required configuration updates to enable running with TLS, enabled in a local docker container environment.
+
+To enable TLS, you need to apply the following configurations on the local file system. Remember to save the files when the configurations are completed.
+
+- [local.env](/local.env) file under the root directory;
+  
+  - update _CALLBACK_ENDPOINT_ to **HTTPS**,
+  
+  - update _INBOUND_MUTUAL_TLS_ENABLED_ to **true**,
+  
+  - Update _OUTBOUND_MUTUAL_TLS_ENABLED_ to **true**.
+	
+```
+CALLBACK_ENDPOINT=https://scheme-adapter:4000
+.
+.
+.
+INBOUND_MUTUAL_TLS_ENABLED=true
+OUTBOUND_MUTUAL_TLS_ENABLED=true
+```
+
+![Local Enabled Mutual TLS](/assets/images/local-mutual-tls-enabled.png)
+
+- [/simulator/scheme-adapter.env](/simulator/scheme-adapter.env) file, make the following update;
+  
+  - Update _INBOUND_MUTUAL_TLS_ENABLED_ to **true**,
+  
+  - Update _OUTBOUND_MUTUAL_TLS_ENABLED_ to **true**.
+
+```
+INBOUND_MUTUAL_TLS_ENABLED=true
+OUTBOUND_MUTUAL_TLS_ENABLED=true
+```
+
+![Adapter Enabled Mutual TLS](/assets/images/adapter-mutual-tls-enabled.png)
+		
+The TLS certificates and keys for the _Mojaloop Switch_ have already been pre-generated and populated for use in the docker container. For information purposes ,the configuration and location are defined in the file content as per the image below. 
+
+![Simulator HUB TLS Certificates and Key](/assets/images/tls-hub-certs-keys.png)
+
+The current configuration caters for a local setup within a docker container. 
+
+Current setup for **Mojaloop Simulator** endpoint, pointing to _scheme-adapter_ as part of the docker containers.
+
+![Simulator Pointing to Scheme-adapter](/assets/images/simulator-scheme-adapter-endpoint.png)
+
+Current setup for **Mojaloop Testing-Toolkit** endpoint, pointing to _mojaloop-testing-toolkit_ as part of the docker containers.
+ 
+![ML Testing Toolkit Pointing to mojaloop-testing-toolkit](/assets/images/testing-toolkit-mojaloop-testing-toolkit-endpoint.png)
+
+### 2 Configure JWS
+
+This section will guide you through the required configurations to run with JWS, enabled in a local docker container environment.
+
+To enable JWS, you need to apply the following configurations on the local file system. Remember to save the files when the config is completed.
+
+- [local.env](/local.env) file under the root directory;
+  
+  - update _VALIDATE_INBOUND_JWS_ to **true**,
+  - update _VALIDATE_INBOUND_PUT_PARTIES_JWS_ to **true**,
+  - update _JWS_SIGN_ to **true**,
+  - update _JWS_SIGN_PUT_PARTIES_ to **true**.
+	
+```
+VALIDATE_INBOUND_JWS=true
+VALIDATE_INBOUND_PUT_PARTIES_JWS=true
+JWS_SIGN=true
+JWS_SIGN_PUT_PARTIES=true
+```
+
+![Local Enabled JWS PublicKey](/assets/images/local-enable-jws-publickey.png)
+
+- [/simulator/scheme-adapter.env](/simulator/scheme-adapter.env) file, make the following update;
+  
+  - Update _INBOUND_MUTUAL_TLS_ENABLED_ to **true**,
+  - Update _VALIDATE_INBOUND_JWS_ to **true**,
+  - Update _VALIDATE_INBOUND_PUT_PARTIES_JWS_ to **true**,
+  - Update _JWS_SIGN_ to **true**,
+  - Update _JWS_SIGN_PUT_PARTIES_ to **true**.
+
+```
+VALIDATE_INBOUND_JWS=true
+VALIDATE_INBOUND_PUT_PARTIES_JWS=true
+JWS_SIGN=true
+JWS_SIGN_PUT_PARTIES=true
+```
+		
+The JWS certificates and publickey for the _Mojaloop Switch_ have already been pre-generated and populated for use in your local docker container. For information purposes, the configuration and location are defined in the file content as per the image below. 
+
+![JWS Hub Certificates and Key](/assets/images/jws-hub-certs-keys.png)
+
+The current configuration caters for a local setup within a docker container. 
+
+Current setup for **Mojaloop Simulator** pointing to _scheme-adapter_ as part of the docker containers.
+
+![Simulator Pointing to Scheme-adapter](/assets/images/simulator-scheme-adapter-endpoint.png)
+
+Current setup for **Mojaloop Testing- Toolkit** pointing to _mojaloop-testing-toolkit_ as part of the docker containers.
+ 
+![ML Testing Toolkit Pointing to mojaloop-testing-toolkit](/assets/images/testing-toolkit-mojaloop-testing-toolkit-endpoint.png)
+
+### 3 Enabling TLS and JWS Verification
+
+As we have made updates to the configuration files for both **Mojaloop Simulator** and **Mojaloop Testing Toolkit**, we will need to restart both docker containers. In the appropriate terminal windows for the 2 applications, stop the docker containers by pressing **Ctrl + C** simultaneously on the keyboard in each terminal window. These actions should "Gracefully stop" the respective local docker containers. To insure all the docker containers are in fact down, run the following command in the respective terminal windows.
+
+```
+docker-compose down
+```  
+
+It is good practice and recommended to verify that all local docker containers are down by running the below command to ensure that there are no local docker containers still active.
+
+```
+docker-compose ps
+```
+
+There shouldn't be any active local docker containers. You should see the following on the respective terminal windows
+
+```
+Name   Command   State   Ports
+------------------------------
+```
+
+To enable the integration with **Mojaloop Connection Manager**, you will need to open a new terminal window to bring up **Mojaloop Connection Manager** service within a local docker container. (We will refer to this new session as "Connection Manager terminal" to avoid confusion. 
+
+The **Mojaloop Connection Manager** is downloaded as part of the **Mojaloop Testing Toolkit**. Just navigate to the respective folder from the project root _/connection-manager_.
+
+```
+cd connection-manager
+```
+
+To start **Mojaloop Connection Manager** as part of the **Mojaloop Testing Toolkit**, execute the below command in the "Connection Manager terminal" terminal window.
+
+```
+docker-compose up
+```  
+
+**Important Notes**
+- The **Mojaloop Connection Manager** environment is created when the **Mojaloop Testing Toolkit** service is started. Please insure the service is available and stable before starting **Mojaloop Testing Toolkit** service.
+
+- The **Mojaloop Testing Toolkit** is a local docker image. With the configuration change to enable TLS and JWS, the local docker image will need to be recreated before restarting **Mojaloop Testing Toolkit**. In the project root directory, execute the following to rebuild the docker image to include the updated configurations.
+
+  ```
+  docker-compose build
+  ```
+
+After the images rebuild is competed, restart **Mojaloop Simulator** and **Mojaloop Testing Toolkit**. Simply run the below command in both the respective terminal windows for the 2 services. The services will startup in the respective docker containers as described in the initial instructions in the [README](/README.md) document.
+
+```
+docker-compose up
+``` 
+
+Once **Mojaloop Testing Toolkit** service is available, open the UI in a browser, as described in the [README](/README.md) document. Verify that the TLS and JWS setting are enabled by navigating to _**Settings**_ on the right hand navigation pane and select _**Settings**_.
+
+As per the initial configurations that was done on the _local.env_ files, you will notice on the _**Runtime Global Configuration**_ window on the left the following settings for JWS and TLS are updated and enabled;
+
+- Callback URL starts with **https://**
+- Enable Inbound JWS Validation is **√**
+- Enable Inbound JWS Signing for PUT /parties is **√**
+- Enable Outbound JWS Signing is **√**
+- Enable Outbound JWS Signing for PUT /parties is **√**
+- Enable Inbound Mutual TLS is **√**
+- Enable Outbound Mutual TLS is **√**
+
+![TLS and JWS Enabled on Environment](/assets/images/tls-jws-enabled-on-environment.png)
+
+By now **Mojaloop Connection Manager** and all other services should br available with the updated security configurations (TLS and JWS). Open a browser and enter ```localhost:5060``` in the url. This will open the **Mojaloop Connection Manager UI**. You will be signed in as a _DFSP_ **dfsp1**, on a _**TESTING-TOOL**_ environment.
+
+*Note* - If a _Username_ and _Password_ is required, enter "test" for both.
+
+![Connection Manager UI Opening](/assets/images/connection-manager-ui-opening.png)
+
+
+### 4 Connection Manager Keys and Certificates
+
+Even though all the certificates for **Mojaloop Testing Toolkit** and **Mojaloop Simulator** have been pre-generated and placed in a folder, ready for use, some manual actions are required to enable the integration with **Mojaloop Connection Manager**. The sample demostration within this document, demostrates **Mojaloop Testing Toolkit** as the testing DFSP and interfacing with the **Mojaloop Simulator** simulating the _Mojaloop Switch_. **Mojaloop Connect Manager** set-up is from the DFSP perspective.
+
+From the **Mojaloop Connect Manager** window, click on the _**TESTING-TOOL**_ environment button.
+
+![MCM Environment Opening](/assets/images/mcm-environment-opening.png)
+
+#### 4.1 Certificate Authorities
+
+On the navigational tab on the left, navigate to _Certificates_ and select _Certificate Authorities_. Under the _DFSP Certificate Authority_ tab in the _Root Certificate_ box, click on _Choose file_ button. Navigate to ```/simulator/secrets/tls/``` and select ```dfsp_client_cacert.pem``` file. 
+
+![dfsp_client_cacert](/assets/images/dfsp-client-cacert.png)
+
+#### 4.2 TLS Client Certificates
+
+Still under _Certificates_ on the navigational tab on the left, select _TLS Client Certificates_. Under the _CSR_ tab in the _CSR_ box, click on the _choose file_ button. Navigate to ```/simulator/secrets/tls/``` and select ```dfsp_client.csr``` file. On submission of this CSR, the testing toolkit will automaticallly sign this and the signed certificate will be available in the _Sent CSR_ tab. Under normal circumstances, you can download this client certificate and provide it to your DFSP implementation. But for this demo, it is already placed in the simulator/tls folder for convinience.
+
+![dfsp_client](/assets/images/dfsp-client.png)
+
+Click on the _**√ Submit**_ button to send the file to the HUB signing.
+
+![dfsp_client Submit](/assets/images/dfsp-client-submit.png)
+
+Now select the _Unprocessed Hub CSRs_ tab. Under normal circumstances, we will download the CSR file and sign it with our _Certificate Authority (CA)_  by clicking on the _Download CSR_ button. For the demo as we already have the signed hub certificate in the folder, this is not necessary, and you can click on the _Upload Certificate_ button on the right of the main window. Navigate to ```/simulator/secrets/tls/``` and select ```hub_client_cert.pem``` file.
+
+![hub_client_cert](/assets/images/hub-client-cert.png)
+
+#### 4.3 TLS Server Certificates
+
+Still under _Certificates_ on the navigational tab on the left, select _TSL Server Certificates_. Under the _DFSP Server certificates_ tab in the _Server certificate_ box, click on the _Choice File_ button. Navigate to ```/simulator/secrets/tls/``` and select ```dfsp_server_cert.pem``` file.
+
+![dfsp_server_cert](/assets/images/dfsp-server-cert.png)
+
+Under the _DFSP Server certificates_ tab in the _Root certificate_ box, click on the _Choose File_ button. Navigate to ```/simulator/secrets/tls/``` and select ```dfsp_server_cacert.pem``` file.
+
+![dfsp_server_cacert](/assets/images/dfsp-server-cacert.png)
+
+Click on the _**√ Submit**_ button
+
+![Server certificates submitted](/assets/images/server-certificates-submitted.png)
+
+To do a quick verification that everything is still functioning as expected, you can repeat the simulator test done in 3.3 [Monitoring]( #3-monitoring).
+
+#### 4.4 JWS Certificates
+
+Still under _Certificates_ on the navigational tab on the left, select _JWS Certificates_. Under the _DFSP JWS Certificates_ tab in the _JWS Certificate_ box, click on the _Choose File_ button. Navigate to ```/simulator/secrets/jws/``` and select ```publickey.cer``` file.
+
+![JWS Certificate](/assets/images/jws-certificate.png)
+
+Click on the _**√ Submit**_ button to upload the JWS Public Key Certificate.
+
+![dfsp_client Submit](/assets/images/jws-certificate-submit.png)
+
+
+### 5 Alternative Set-ups
+
+It is possible for **Mojaloop Testing Toolkit** to function outside of a _local_ environment, enabling more advance integration testing and verifications between a _Mojaloop Switch_ and testing DFSP before going live. These are not covered within the boundaries of this document, but you are more than welcome to explore this functionality.
+
+Please be aware should you set-up on another environment or DFSPs, some variables will need to be updated like the DNS or IP address of the server. Certificates and keys will also need to be generated and implemented for the new environment and DFSPs should TLS and JWS be enabled.
+
+These configurations will be covered in a separate document. This will include the actions required on **Mojaloop Connection Manager**, **Mojaloop Testing Toolkit** and **Mojaloop Simulator** to enable the adding of DFSPs, and testing with new environments for DFSPs.
+
+This document will provide guidance on the following;
+- add a new DFSP on an existing environment,
+- add a new environement for a DFSP,
+- guide you to create your own TLS and JWS certificate and keys for inclusion into **Mojaloop Connection Manager**,
+- guide you through the configuration required to integrate functionality between the testing entities.
+
+Script files are provided in the respective directories to speed up the process to generate these certificates for both the **Mojaloop Simulator** and **Mojaloop Testing Toolkit**. 
+
+- **Mojaloop Simulator** the file path;
+  /simulator/secrets/tls/createSecrets.sh
+  /simulator/secrets/jws/keygen.sh
+
+- **Mojaloop Testing Toolkit** the file path;
+  /secrets/tls/createSecrets.sh
+  /secrets/keygen.sh
+
+As mentioned in the begining of this section, the aforementioned scenarios will be elaborated on in a seperate document.

package/documents/User-Guide-Frequently-Asked-Questions.md

@@ -0,0 +1,39 @@
+# Users Guide Frequently Asked Questions
+
+## _Mojaloop Testing Toolkit_
+
+This section will list a number a frequently asked questions and the solutions provided.
+
+**Table of Contents**
+
+0. [User Guide](/documents/User-Guide.md)
+
+1. [Mojaloop Connection Manager require sign on](#1-mojaloop-connection-manager-require-sign-on)
+
+2. [Generic ID not found](#2-generic-id-not-found)
+
+### 1 Mojaloop Connection Manager require sign on
+
+When opening **Mojaloop Connection Manager** in my browser, a _**Username**_ and _**Password**_ is required.
+  - The default is to open to the available environment, _**TESTING-TOOLKIT**_ as default. After the initial opening, and a time lapses, the **Mojaloop Connection Manager UI** will request you to sign on. Use the default _**Username**_ => ```test``` and _**Password**_ => ```test```.
+
+### 2 Generic ID not found
+
+When I run the _**Outbound Request**_, I receive failures on the Callback response;
+
+```
+{
+  "body": {
+    "errorInformation": {
+      "errorCode": "3200",
+      "errorDescription": "Generic ID not found"
+    }
+  }
+}
+```
+
+- The reason for this is the **Inbound User** is no present on the **Mojaloop Simulator**. For the samples used in this document, you will need to create a new user for **MSISDN** = **9876543210**. In the **Mojaloop Simulator UI**, select _**+ Add User**_ button on the _**Config Inbound**_ navigation tab. Below screenshot is a sample based on the sample data used within this document. Click on the _**√ Submit**_ button when done. 
+
+You are welcome to change any values as required. Important values to keep in mind, are the _Id Type_, _Id Value_ and the _DateOfBirth_ date format _(CCYY-MM-DDD)_.
+
+![Create Inbound User on Simulator](/assets/images/create-inbound-user-simulator.png)

package/documents/User-Guide-Hosted-Mode-Docker-Compose.md

@@ -0,0 +1,110 @@
+# Hosted Mode with "Docker Compose" (Without JWS and mTLS)
+
+## _Mojaloop Testing Toolkit_
+
+**Table of Contents**
+
+1. [Introduction](#1-introduction)
+
+2. [Installation](#2-installation)
+
+3. [Creating a group and user for new DFSP](#3-creating-a-group-and-user-for-new-dfsp)
+
+4. [Login into TTK UI](#4-login-into-ttk-ui)
+
+5. [Sending a Transfer](#5-sending-a-transfer)
+
+
+## 1. Introduction
+
+TTK can be deployed in hosted mode using the docker-compose file provided in the TTK repository. In this method, DFSP can not use mTLS and JWS to communicate with TTK.
+
+![Hosted Mode Docker-Compose](/assets/images/hosted-mode-docker-compose-intro.png)
+
+## 2. Installation
+
+* Clone the TTK repository
+* Run the following commands
+
+```bash
+git clone https://github.com/mojaloop/ml-testing-toolkit
+cd ml-testing-toolkit/docker/hosted-mode
+docker-compose up
+```
+
+You should see the following services up and running.
+* TTK backend service
+* TTK frontend service
+* MongoDB for storing details like rules, settings, logs and history per DFSP
+* Keycloak Server for authentication by DFSPs
+
+After all the services up and running, the following setup steps are needed for a typical scenario.
+* [Hub User] Create a group for a new DFSP (Ex: dfsp1)
+* [Hub User] Create a user from the new DFSP and assign the corresponding group (Ex: user1)
+* [Hub User] Provide the user credentials to DFSP
+* DFSP will login to the TTK UI using the credentials
+* DFSP gets the token configuration from settings page
+* DFSP will provision the token details in his implementation
+* DFSP can send a transfer to TTK (DFSP) and monitor the requests in monitoring page
+
+
+## 3. Creating a group and user for new DFSP
+
+For creating an account for DFSP, we need to use keycloak admin web interface.
+
+* Open the keycloak web interface on http://<Host>:8080
+* Go to “Administration Console”
+* Login with username “admin” and password “admin” (These default values can be configured using environment values in docker-compose file)
+
+### Creating a group for a new DFSP
+
+* Goto groups in the menu
+* Click on “New” button at the right
+* Enter the group name in the format /Application/DFSP:dfspName
+Where you should replace the string “dfspName” with your DFSP ID
+* Save the group
+
+### Creating new user for DFSP
+
+* Goto users in the menu
+* Click on “Add User”
+* Enter the username as “user1” and click on “Save”
+* Goto “Credentials” tab and set the password. Disable “Temporary” checkbox.
+* Goto “Groups” tab and join the following groups
+  * /Application/DFSP:<dfspName>
+  * /Application/MTA
+  * /Internal/everyone
+* Goto “Attributes” tab and add an attribute the name ‘dfspId’ and value ‘<dfspName>’
+
+That’s it, now a DFSP has been created and also we created a user. Provide the user credentials to DFSP so that they can login in the TTK UI.
+
+## 4. Login into TTK UI
+
+Now a DFSP (user) can login into TTK UI for configuring user settings like callback endpoints and for getting token information.
+
+* Open the TTK UI with URL http://IP:6060
+* Login with the credentials provided by scheme
+* Goto **“Settings”** page
+* Set the callback endpoint to point to the DFSP’s IP address and port where the service is running
+
+SDK-scheme-adapter and payment manager uses **“OAuth 2.0 Client Credentials Grant”** flow to get the access token periodically from the oAuth server.
+If the DFSP is using payment manager or sdk-scheme-adapter for their implementation, the token information is available on the setting page.
+
+* Click on the **“Token Info”** button
+* The details like “client_id”, “client_secret” and “token_endpoint” will be displayed on the popup window
+* DFSP can provide the details in his implementation (sdk-scheme-adapter / payment manager)
+* If the DFSP wants to test requests temporarily with a http client / postman, a temporary access token can be generated  by clicking on the button **“Generate a Static Token”**. Typically the token expires in one hour.
+* DFSP needs to include the generated token in the **“Authorization”** header as “Bearer TOKEN”
+
+## 5. Sending a Transfer
+
+
+After configuring the callback endpoint(s) in TTK and token information in DFSP implementation, a DFSP can send a transfer to TTK.
+
+Before sending a transfer, open the monitoring page in TTK UI. All the inbound requests from DFSP implementation and the callbacks generated and sent by TTK will be shown on the monitoring page.
+
+We can expand relevant entries here and see the logs, content of the requests and callbacks including header information.
+
+TTK validates the schema of all the inbound requests and shows if there are any validation failures.
+
+If there are other issues with the parameters in the mojaloop requests, the transfer will fail and DFSP can analyze the problem with the help of logs, entries in the monitoring page.