diff --git a/README.md b/README.md index 5f5f5bf..75543bf 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,28 @@ Thank you for using the APIM Deployer script to deploy the API Manager 4.0.0 in ## For MAC OS users can use the below command to deploy the API Manager 4.0.0 in fully distributed way. - ###FORMAT + ### FORMAT ```sh APIM_DEPLOYER_MAC.sh -f / -z -b wso2am-4.0.0 -d -r -p -c / -a -s -u ``` - ###EXAMPLE + ```sh APIM_DEPLOYER_MAC.sh -z -b wso2am-4.0.0 -d -r -p -a -s -u ``` + + ### EXAMPLE ```sh APIM_DEPLOYER_MAC.sh -f /home/sumudu/.wum3/products/wso2am/4.0.0/wso2am-4.0.0.zip -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -c /home/sumudu/.wum3/products/wso2am/mysql-connector-java-8.0.27.jar -a TEST_APIM_DB -s TEST_SHARED_DB -u 91``` + ```sh APIM_DEPLOYER_MAC.sh -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -a TEST_APIM_DB -s TEST_SHARED_DB -u 91``` + ## For Linux OS users can use the below command to deploy the API Manager 4.0.0 in fully distributed way. - ###FORMAT + ### FORMAT ```sh APIM_DEPLOYER_LINUX.sh -f / -z -b wso2am-4.0.0 -d -r -p -c / -a -s -u ``` - ###EXAMPLE + ```sh APIM_DEPLOYER_LINUX.sh -z -b wso2am-4.0.0 -d -r -p -a -s -u ``` + + ### EXAMPLE ```sh APIM_DEPLOYER_LINUX.sh -f /home/sumudu/.wum3/products/wso2am/4.0.0/wso2am-4.0.0.zip -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -c /home/sumudu/.wum3/products/wso2am/mysql-connector-java-8.0.27.jar -a TEST_APIM_DB -s TEST_SHARED_DB -u 91``` + ```sh APIM_DEPLOYER_LINUX.sh -z wso2am-4.0.0.zip -b wso2am-4.0.0 -d FULL -r root -p PASSWORD -a TEST_APIM_DB -s TEST_SHARED_DB -u 91``` + ## Flags `-v` => To get the version of this script @@ -37,7 +45,7 @@ Eg: \n sh APIM_DEPLOYER_.sh -h - FULL => Traffic Manager separated deployment. (Control Plane, Traffic Manager and Gateway Worker) - GWCP => Gateway Worker and Control Plane deployment. (Control Plane and Gateway Worker) -`-f` => Base pack location path +`-f` => Base pack location path (Optional) `-z` => ZIP file name of the APIM pack (Eg: wso2am-4.0.0.zip) @@ -47,7 +55,7 @@ Eg: \n sh APIM_DEPLOYER_.sh -h `-p` => Root user password of the MySQL server -`-c` => Path of the MySQL JDBC connector Jar +`-c` => Path of the MySQL JDBC connector Jar (Optional) `-a` => APIM database name