Quick start

Prerequisites:

Install docker
- On linux: install the docker package
- On OSX or Windows: Install docker desktop
Enable swarm mode in docker: docker swarm init

To get started with Instant OpenHIE you will first need to download the CLI tool. The binary may be download via the terminal with the following url based on your operating system

Download the binary

sudo curl -L https://github.com/openhie/instant-v2/releases/latest/download/instant-linux -o /usr/local/bin/instant

Grant the binary executable permissions

sudo chmod +x /usr/local/bin/instant

Download the binary

sudo curl -L https://github.com/openhie/instant-v2/releases/latest/download/instant-macos -o /usr/local/bin/instant

Grant the binary executable permissions

sudo chmod +x /usr/local/bin/instant

Ensure docker desktop is using the default context else Instant won't be able to run docker containers

docker context use default

To test that the binary works, run the executable with no commands to see the help text.

$ instant
A cli to assist with package deployment and management

Usage:
  cli [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command
  package     Package level commands
  project     Project level commands
  version     Print the CLI version

Flags:
  -h, --help   help for cli

Use "cli [command] --help" for more information about a command.

Next, you would want to configure which packages Instant can deploy for your particular needs.

Instant doesn't ship with any default packages to deploy. Packages are expected to be created by the community and in time there will be many option available. Jembi has curated a set of packages that we commonly use to help implementer to get started with a foundational set of health information exchange components. To get started with that pre-configured package set, see the OpenHIM Platform docs.

Otherwise, you may create your own config for your own set of packages. Continue to config section to find out how.

PreviousGet Started NextConfig

Last updated 9 months ago

Was this helpful?

$ instant A cli to assist with package deployment and management Usage: cli [command] Available Commands: completion Generate the autocompletion script for the specified shell help Help about any command package Package level commands project Project level commands version Print the CLI version Flags: -h, --help help for cli Use "cli [command] --help" for more information about a command.