It is important for you to validate that IDHub has been installed correctly in your environment, and this guide will help to ensure a successful installation. Below is a list of steps to help determine if all containers are up and running. All components should be healthy and working as expected.

Ways to Validate IDHub Installation

Command Prompt SSH Validation

Steps to perform:

  • Open Command Prompt
  • Enter "docker ps"
  • View containers list along with Container ID, Created Date, Status and Ports
  • Observe status section (as shown in image below)
  • If installation is done correctly, all statuses will show Healthy and/or UP

--------------------------------------------------------------- TO BE USED AFTER V20.3.0 --------------------------------------------------------------------------

Health Check

IDHub also has a Health Check section, which is used for end-users to validate all services of IDHub in real time.

  • Go to https://<environment domain name>/health
  • You should be able to see all services of IDHub and their running statuses.

Portainer Validation

If you have Portainer.IO installed in your environment, that can also be used to view status of the containers.

  • Go to http://<ip address of the environment>:9000/
  • Login to Portainer (View image below)

Healthy or running containers are a good sign. Check if any containers appear to be "stopped".
If so, you'll need to restart the container to resolve the issue.

Actuator Validation

If you have Actuator tool installed in your environment, that can also be used to view status of the containers.

  • http://<ip address of the environment>:9097/
  • Login to Actuator (View image below)

Determine if any of the services are showing any error.

UI Manual Validation

This is manual validation of IDHub Functionalities, to check IDHub installation. This can be performed via Setup Guide.

What next?

If you are a first time IDHub user, we have a comprehensive User Setup Guide, used to setup your environment with applications and user on-boarding of your organization. Complete the Setup Guide for a complete IDHub experience!

Remediation in Case of Errors

After validations, in the event of a faulty installation, below are multiple ways remediation can be made:

  • Perform re-installation of IDHub
  • Check logs in case a tool is used for validation.
  • Start/Stop IDHub to see if it resolves the issues detected.
  • Upgrade to the latest version of IDHub, in case you may be working on a discontinued version of IDHub.

Some of the above remediation methods are explained below.

Need more help?

Folks at IDHub are ready to support you.

Starting and Stopping IDH

cd /apps/idhub/idhub-<modality>-<version>

cd /apps/idhub/idhub-<modality>-<version>

Upgrade of IDH

cd /apps/idhub
tar -xvzf idhub-<modality>-<version>.tar.gz
cd idhub-<modality>-<version>