Fix documentation

[nonrtric.git] / test / http-https-proxy / README.md

diff --git a/test/http-https-proxy/README.md b/test/http-https-proxy/README.md
index 271db4d..20413f3 100644 (file)
--- a/test/http-https-proxy/README.md
+++ b/test/http-https-proxy/README.md
@@ -1,11 +1,11 @@
-## http proxy ##
+# http proxy
 
 The http proxy is a generic http proxy which is able to proxy both http and https destination calls.
 The call to the proxy (to control the proxy call) also supports both http and https (https is using a self signed cert).
 The main usage for the proxy is as a gateway to all services and pod inside a kubernetest cluster.
 However, it can be used a basic standard http proxy as well.
 
-# Ports and certificates
+## Ports and certificates
 
 The proxy opens the http and https port according to the table below.
 
@@ -18,19 +18,18 @@ The proxy opens the http and https port according to the table below.
 
 The dir cert contains a self-signed cert. Use the script generate_cert_and_key.sh to generate a new certificate and key before building the container, the certs need to be re-generated. If another cert is used, all three files (cert.crt, key.crt and pass) in the cert dir should be mounted to the dir '/usr/src/app/cert' in the container.
 
-
-### Proxy usage ###
+### Proxy usage
 
 | Operation | curl example |
 | --------- | ------------ |
-| proxy http call via http | curl --proxy localhost:8080 http://pms:1234 |
-| proxy https call via http | curl --proxy localhost:8080 https://pms:5678 |
-| proxy http call via https | curl --proxy-insecure localhost:8433 http://pms:1234 |
-| proxy https call via https |  curl --proxy-insecure localhost:8433 https://pms:5678 |
+| proxy http call via http | curl --proxy <http://localhost:8080> <http://100.110.120.130:1234> |
+| proxy https call via http | curl -k --proxy <http://localhost:8080> <https://100.110.120.130:5678> |
+| proxy http call via https | curl --proxy-insecure --proxy <https://localhost:8433> <http://100.110.120.130:1234> |
+| proxy https call via https | curl --proxy-insecure --proxy <https://localhost:8433> <https://100.110.120.130:5678> |
 | alive check and get stats | curl localhost:8081 |
-| alive check and get stats via proxy |  curl --proxy localhost:8080 http://localhost:8081 |
+| alive check and get stats via proxy |  curl --proxy localhost:8080 <http://localhost:8081> |
 
-### Build and start ###
+### Build and start
 
 >Build image<br>
 ```docker build --build-arg NEXUS_PROXY_REPO=nexus3.onap.org:10001/ -t nodejs-http-proxy:latest .```
@@ -42,8 +41,7 @@ It will listen to http ports 8080/8081 and https ports 8433/8434 (using default
 
 The script ```proxy-build-start.sh``` do the above two steps in one go. This starts the container in stand-alone mode for basic test.<br>
 
-
-### Basic test ###
+### Basic test
 
 Basic test is made with the script ```basic_test.sh``` which tests proxy. Use the script ```proxy-build-start.sh``` to start the proxy in a container first.
 
@@ -60,4 +58,4 @@ 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.
\ No newline at end of file
+limitations under the License.