Skip to content

Commit

Permalink
Merge pull request #159 from Chathuratharushka/multiple-product-versions
Browse files Browse the repository at this point in the history
fixing the minor issues in the README.mds
  • Loading branch information
DivyaPremanantha authored Jun 30, 2023
2 parents b9b60d6 + 6a3d399 commit 60ad7e8
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 18 deletions.
6 changes: 3 additions & 3 deletions dockerfiles/alpine/obam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section defines the step-by-step instructions to build an [Alpine](https://
> Rename the `OB_SandBox_PP_Root.cer` as `root.cer`.
> Rename the `OB_SandBox_PP_Issuing.cer` as `iss.cer`.
> Zip the root.cer and iss.cer in one zip archive file.
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -34,8 +34,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBAM_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obam:3.0.0-alpine .` <br>
> eg:- **Hosted locally**: `docker build --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/obam-keystores -t wso2-obam:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/obam-keystores -t wso2-obam:3.0.0-alpine .`
> eg:- **Hosted locally**: `docker build --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obam:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obam:3.0.0-alpine .`
##### 3. Running the Docker image.

Expand Down
6 changes: 3 additions & 3 deletions dockerfiles/alpine/obbi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This section defines the step-by-step instructions to build an [Alpine](https://
* [Docker](https://www.docker.com/get-docker) v20.10.10 or above
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) client
* WSO2 Open Banking Business Intelligence Accelerator Module pack downloaded through [WSO2 Updates 2.0](https://ob.docs.wso2.com/en/latest/install-and-setup/setting-up-servers/)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -29,8 +29,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBBI_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg BASE_PRODUCT_VERSION=<APIM BASE PRODUCT VERSION> --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obbi:3.0.0-alpine .` <br>
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/keystores -t wso2-obbi:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/keystores -t wso2-obbi:3.0.0-alpine .`
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obbi:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obbi:3.0.0-alpine .`
##### 3. Running the Docker image.

Expand Down
6 changes: 3 additions & 3 deletions dockerfiles/alpine/obiam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section defines the step-by-step instructions to build an [Alpine](https://
> Rename the `OB_SandBox_PP_Root.cer` as `root.cer`.
> Rename the `OB_SandBox_PP_Issuing.cer` as `iss.cer`.
> Zip the root.cer and iss.cer in one zip archive file.
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -36,8 +36,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBIAM_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg BASE_PRODUCT_VERSION=<IS BASE PRODUCT VERSION> --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obiam:3.0.0-alpine .` <br>
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/obiam-keystores -t wso2-obiam:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/obiam-keystores -t wso2-obiam:3.0.0-alpine .`
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obiam:3.0.0-alpine .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obiam:3.0.0-alpine .`
##### 3. Running the Docker image.
if you are only using the WSO2 Open Banking Identity Server, please run the below command.
Expand Down
6 changes: 3 additions & 3 deletions dockerfiles/ubuntu/obam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section defines the step-by-step instructions to build an [Ubuntu](https://
> Rename the `OB_SandBox_PP_Root.cer` as `root.cer`.
> Rename the `OB_SandBox_PP_Issuing.cer` as `iss.cer`.
> Zip the root.cer and iss.cer in one zip archive file.
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -35,8 +35,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBAM_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg BASE_PRODUCT_VERSION=<APIM BASE PRODUCT VERSION> --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obam:3.0.0 .` <br>
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/keystores -t wso2-obam:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/keystores -t wso2-obam:3.0.0 .`
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obam:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obam:3.0.0 .`
##### 3. Running the Docker image.

Expand Down
6 changes: 3 additions & 3 deletions dockerfiles/ubuntu/obbi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This section defines the step-by-step instructions to build an [Ubuntu](https://
* [Docker](https://www.docker.com/get-docker) v20.10.10 or above
* [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) client
* WSO2 Open Banking Business Intelligence Accelerator Module pack downloaded through [WSO2 Updates 2.0](https://ob.docs.wso2.com/en/latest/install-and-setup/setting-up-servers/)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -29,8 +29,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBBI_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg BASE_PRODUCT_VERSION=<APIM BASE PRODUCT VERSION> --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obbi:3.0.0 .` <br>
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/keystores -t wso2-obbi:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/keystores -t wso2-obbi:3.0.0 .`
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obbi:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=4.2.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obbi-accelerator-3.0.0.tar.gz --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obbi:3.0.0 .`
##### 3. Running the Docker image.

Expand Down
6 changes: 3 additions & 3 deletions dockerfiles/ubuntu/obiam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This section defines the step-by-step instructions to build an [Ubuntu](https://
> Rename the `OB_SandBox_PP_Root.cer` as `root.cer`.
> Rename the `OB_SandBox_PP_Issuing.cer` as `iss.cer`.
> Zip the root.cer and iss.cer in one zip archive file.
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/keystores)
* Keystores directory of wso2 server certs of WSO2 Open Banking Docker Images. (https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores)

+ Host the downloaded artifacts locally or on a remote location.
> The hosted locations of artifacts will be passed as the build arguments when building the Docker image.<br>
Expand All @@ -36,8 +36,8 @@ git clone https://github.com/wso2/docker-open-banking.git
- Navigate to `<OBIAM_DOCKERFILE_HOME>` directory. <br>
Execute `docker build` command as shown below.
+ `docker build --build-arg BASE_PRODUCT_VERSION=<IS BASE PRODUCT VERSION> --build-arg WSO2_OB_ACCELERATOR_DIST_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg OB_TRUSTED_CERTS_URL=<URL_OF_THE_HOSTED_LOCATION/FILENAME> --build-arg WSO2_OB_KEYSTORES_URL=<URL_OF_THE_HOSTED_LOCATION/FOLDER_NAME> -t wso2-obiam:3.0.0 .` <br>
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://localhost:8000/keystores -t wso2-obiam:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=http://<public_ip:port>/keystores -t wso2-obiam:3.0.0 .`
> eg:- **Hosted locally**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://localhost:8000/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://localhost:8000/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obiam:3.0.0 .` <br><br>
> eg:- **Hosted remotely**: `docker build --build-arg BASE_PRODUCT_VERSION=6.0.0 --build-arg WSO2_OB_ACCELERATOR_DIST_URL=http://<public_ip:port>/wso2-obiam-accelerator-3.0.0.tar.gz --build-arg OB_TRUSTED_CERTS_URL=http://<public_ip:port>/ob-cert.zip --build-arg WSO2_OB_KEYSTORES_URL=https://github.com/wso2/docker-open-banking/raw/v3.0.0.10/dockerfiles/keystores -t wso2-obiam:3.0.0 .`
##### 3. Running the Docker image.
if you are only using the WSO2 Open Banking Identity Server, please run the below command.
Expand Down

0 comments on commit 60ad7e8

Please sign in to comment.