Skip to content

Commit

Permalink
MOSIP-37357 Corrected Readme
Browse files Browse the repository at this point in the history
Signed-off-by: kameshsr <[email protected]>
  • Loading branch information
kameshsr committed Dec 2, 2024
1 parent 2e3738d commit fa10c50
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 29 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,11 @@ This is to maintain compatibility with existing ANT-style path patterns.
```
## Configuration
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/develop/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/develop/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/develop/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/develop/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
## Deployment in K8 cluster with other MOSIP services:
Expand Down
15 changes: 8 additions & 7 deletions authentication/authentication-internal-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Any combination of the supported [authentication types](https://docs.mosip.io/1.

## Modalities
* Refer [biometric modalities](https://docs.mosip.io/1.2.0/biometrics#modalities).
* Above authentication types can be allowed/disallowed/mandated by the [configuraion](../../docs/configuration.md#allowed-authentication-types) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).
* Above authentication types can be allowed/disallowed/mandated by the [configuration](../../docs/configuration.md)
and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).

## Endpoints
* Internal Authentication - used by Internal MOSIP modules for authenticating an individual's UIN/VID
Expand Down Expand Up @@ -67,7 +68,7 @@ This is to maintain compatibility with existing ANT-style path patterns.
$ cd authentication/authentication-internal-service
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
1. Build Docker for a service:
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
Expand All @@ -82,10 +83,10 @@ This is to maintain compatibility with existing ANT-style path patterns.
```
## Configuration
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/develop/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/develop/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/develop/id-authentication-internal-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
## Deployment in K8 cluster with other MOSIP services:
Expand Down Expand Up @@ -117,4 +118,4 @@ Automated functional tests available in [Functional Tests](../../api-test).
API documentation is available [here](https://mosip.github.io/documentation/).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE).
16 changes: 8 additions & 8 deletions authentication/authentication-otp-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ This is to maintain compatibility with existing ANT-style path patterns.

1. Build and install:
```
$ cd authentication
$ cd authentication/authentication-otp-service
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
1. Build Docker for a service:
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
Expand All @@ -69,11 +69,11 @@ This is to maintain compatibility with existing ANT-style path patterns.
```
## Configuration
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/develop/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/develop/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/develop/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/develop/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
## Deployment in K8 cluster with other MOSIP services:
Expand Down Expand Up @@ -105,4 +105,4 @@ Automated functional tests available in [api-test folder](../../api-test).
API documentation is available [here](https://mosip.github.io/documentation/).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE).
18 changes: 9 additions & 9 deletions authentication/authentication-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Any combination of the supported [authentication types](https://docs.mosip.io/1.

## Modalities
* Refer [biometric modalities](https://docs.mosip.io/1.2.0/biometrics#modalities).
* Above authentication types can be allowed/disallowed/mandated by the [configuraion](../../docs/configuration.md#allowed-authentication-types) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).
* Above authentication types can be allowed/disallowed/mandated by the [configuration](../../docs/configuration.md) and the [Authentication/E-KYC Partner's Policy](../../docs/configuration.md).

## Partner/MISP validation
* Below partner/MISP data are validated before processing the authentication request:
Expand Down Expand Up @@ -66,10 +66,10 @@ This is to maintain compatibility with existing ANT-style path patterns.

1. Build and install:
```
$ cd authentication
$ cd authentication/authentication-service
$ mvn install -DskipTests=true -Dmaven.javadoc.skip=true -Dgpg.skip=true
```
1. Build Docker for a service:
2. Build Docker for a service:
```
$ cd <service folder>
$ docker build -f Dockerfile
Expand All @@ -84,11 +84,11 @@ This is to maintain compatibility with existing ANT-style path patterns.
```
## Configuration
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/develop/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/develop/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/develop/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/develop/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/develop/application-default.properties) defined here.
[Configuration-id-authentication](https://github.com/mosip/mosip-config/blob/master/id-authentication-default.properties)and
[Configuration-id-authentication-external](https://github.com/mosip/mosip-config/blob/master/id-authentication-external-default.properties) and
[Configuration-id-authentication-internal](https://github.com/mosip/mosip-config/blob/master/id-authentication-internal-default.properties) and
[Configuration-id-authentication-otp](https://github.com/mosip/mosip-config/blob/master/id-authentication-otp-default.properties) and
[Configuration-Application](https://github.com/mosip/mosip-config/blob/master/application-default.properties) defined here.
## Deployment in K8 cluster with other MOSIP services:
Expand Down Expand Up @@ -120,4 +120,4 @@ Automated functional tests available in [api-test folder](../../api-test).
API documentation is available [here](https://mosip.github.io/documentation/).
## License
This project is licensed under the terms of [Mozilla Public License 2.0](LICENSE).
This project is licensed under the terms of [Mozilla Public License 2.0](../../LICENSE).

0 comments on commit fa10c50

Please sign in to comment.