diff --git a/README.md b/README.md index 2d35507..c766b83 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,34 @@ - [Configuration Guide](docs/tech/configuration.md) - [API Usage](docs/API-Guide.md) +## LACPass Client component + +### Summary +The LACCPass Client component allows Ministries of Health to handle the onboarding, as well as the issuance and delivery of health certificates to patients. +This section contains the steps to run the LACPass Client component, and specifies how to use the endpoints. + +### Requirements +- Make sure you have up and running and instance of the LACPass Client component available at https://github.com/lacchain/IPS-national-backend +- Access to the client-helper executable script available at https://github.com/lacchain/IPS-national-backend#lacchain-setup-and-onboard-helper + +### Verify Service availability +1. Running the lacpass-lacchain component from IPS-national-backend will expose the service at port 3010 +2. Verify the lacpass-lacchain component is running either checking the logs or just performing a telnet command in a bash shell: + +![](https://github.com/LACPass-client/docs/examples/telnet3010.png) + +### Running Setup/Onboard steps + +It is time to run the CLI (Client helper executable script) to setup your DID and set some keys. +1. Make sure you have verified the service availability as described in the previous section +2. Before running the CLI make sure to execute this in a linux bash terminal: ./client-helper.sh +3. Now enter the URL of the lacpass-lacchain verified in the previous section +4. The following menu is presented: +5. If you don't have a PKI or don't have any signing key to attest health certificates then you can create a Self-Signed Certificate "SSC". Type that if needed and enter the required information. +- The end of this process will create a directory named "cert" inside the directory you are running the script: +* NOTE: DSC.key will be the private key used to sign Health Certificates. For that: +* You can copy the DSC.key into the directory cert-data located in the root directory of your IPS-national-backend repository. + ## Changelog +- [Changelog](./CHANGELOG.md) -- [Changelog](./CHANGELOG.md) \ No newline at end of file diff --git a/docs/examples/telnet3010.png b/docs/examples/telnet3010.png new file mode 100644 index 0000000..39ed886 Binary files /dev/null and b/docs/examples/telnet3010.png differ