Skip to content

Latest commit

 

History

History
82 lines (50 loc) · 3.19 KB

README.md

File metadata and controls

82 lines (50 loc) · 3.19 KB
Raw

WHO SVC Transactions Mediator

FROM: Openhim Production Bootstrap Mediator

Startup

To startup this mediator, you are expected to have the following:

  • An instance of the OpenHIM-Core, OpenHIM-Console, and MongoDB running
  • An OpenHIM user account with permissions to access the API endpoint
  • An OpenHIM Client setup (clientId and password)

If not, please see this tutorial

Configuring Mediator

This mediator is configured using environment variables.

An environment variable is a variable whose value is set outside the program, typically through functionality built into the operating system or micro-service. An environment variable is made up of a name/value pair, and any number may be created and available for reference at a point in time.

The following variables can be set:

Environment Variable Default Description
SERVER_PORT 3002 The exposed port of the mediator
OPENHIM_URL https://localhost:8080 The location of the the OpenHIM API
OPENHIM_USERNAME [email protected] Registered OpenHIM Username
OPENHIM_PASSWORD openhim-password Password of the registered OpenHIM user
TRUST_SELF_SIGNED false In development environments the OpenHIM uses self-signed certificates therefore it is insecure. To allow the mediator to communicate with the OpenHIM via HTTPS this variable can be set to true to ignore the security risk. This should only be done in a development environment

Node && NPM

To run startup the RedCap mediator open a terminal and navigate to the project directory and run the following commands:

npm install

<Environment_Variables> npm start

Example start command:

SERVER_PORT=4321 OPENHIM_PASSWORD=password npm start

Docker

To run startup the bootstrap mediator open a terminal and navigate to the project directory and run the following commands:

docker build -t skeleton-mediator .

docker network ls

docker run -e OPENHIM_PASSWORD=password -e SERVER_PORT=4321 --network {openhim-network} --name skeleton-mediator --rm skeleton-mediator

If you start the skeleton mediator with Docker it would be easiest to also have the OpenHIM Core running in a container using Docker. See this tutorial for setting up the OpenHIM with docker and connecting mediators on the same network

Configuring OpenHIM

To route requests from a client to destination systems, the OpenHIM needs to have channels configured to listen for specific requests and send them to specific endpoints.

This mediator is configured (within mediatorConfig.json) to create some default channels and endpoints. To create these channels navigate to the mediators page on the OpenHIM Console.

Sending Requests

To make a basic POST request, open a terminal (or Postman) and make the following request:

curl --request POST --data "{}" --user admin:password http://localhost:5001/testEndpoint

The user details here are your OpenHIM ClientId and password.