Skip to content

Commit

Permalink
Updating README
Browse files Browse the repository at this point in the history
  • Loading branch information
antonio-leal-batista committed Oct 13, 2023
1 parent 970009b commit f34d4a9
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 1 deletion.
30 changes: 29 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Binary file added docs/examples/telnet3010.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f34d4a9

Please sign in to comment.