Adminstrator Docs

Install, deploy and administer IDHub with ease

Build Your Own Custom Experiences

Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore.

Docker Installation Information

1. Introduction

Every Identity Management Platform requires planning and preparation for a successful implementation. Simplify your IDHub self-managed Docker based deployment with instructions listed below. 

Docker Installation:

  • 20 minute installation
  • Container based install
  • All services on a single host

Chose this installation when: 

  • Rapid deployment is required.
  • Up to a 1000 users
  • Deploying for development, proof of concept and testing environments

2. Minimum Requirements

Minimum Requiremetns for Docker:

Hardware:

  • Memory – Minimum 12GB (Recommended 24GB)
  • CPU – Minimum 4 core (Recommended 8 cores)
  • Hard Drives – Minimum 100 GB (Recommended 500 GB)
  • Docker – Minimum Version 18
  • Docker Compose – Minimum Version 1.2
  • Ansible – Minimum Version 2.7

Network:

Minium 1 Gbps

Firewall:

Port 443 available

 

3. Server Preparation Steps

  1. Identify the server type: Physical Server or Virtual Machine.
  2. Install Docker (see Requirements for version) -https://docs.docker.com/install/
  3. Install Docker compose – https://docs.docker.com/compose/install/
  4. Ensure network ports are identified in the architecture diagram are available and they can be established
  5. Confirm and document any firewall requirements.
  6. Download the IDHub installer from download.sath.com
  7. Identify specific location for install and the fully qualified server name (FQDN) where IDHub is going to be hosted.
  8. Prepare SSL key and certificate in prep for install (Provide foot note to the link to be provided by Joe)
    • Create self-signed certificate – https://www.digitalocean.com/community/tutorials/how-to-create-a-self-signed-ssl-certificate-for-nginx-in-ubuntu-18-04
    • Create a publicly signed certificate – https://www.godaddy.com/help/nginx-install-a-certificate-6722 http://nginx.org/en/docs/http/configuring_https_servers.html#chains
  9. Inventory of all servers and the connections between them.
  10. Identify mount points and check for disk space.
  11. Ensure this partition has enough space to contain docker data files based on sizing (size of instance). Consider changing the image path to a partition that has enough space.
  12. Create an install path called /apps/idhub
  13. Copy installer under /apps/idhub
  14. Default path for Docker volumes is /var/lib/docker

4. Installation Steps

Installation Steps

  1. Download the installer package for IDHub from the Sath download site at download.sath.com
  2. Move the package to /apps/idhub
  3. Type in the following commands to start the install
cd /apps/idhub
curl https://download.sath.com/files/idhub-<modality>-<version>.tar.gz
tar -xvzf idhub-<modality>-<version>.tar.gz
cd idhub-<modality>-<version>
copy </path/to/ssl.key> config/ssl.key
copy </path/to/ssl.crt> config/ssl.crt
install.sh

Verification of Install

Browse to https://<FQDN>/health

Starting and Stopping IDHub

cd /apps/idhub/idhub-<modality>-<version>
start.sh
 
cd /apps/idhub/idhub-<modality>-<version>
stop.sh

Upgrade of IDHub

cd /apps/idhub
curl https://download.sath.com/files/idhub-<modality>-<version>.tar.gz
tar -xvzf idhub-<modality>-<version>.tar.gz
cd idhub-<modality>-<version>
upgrade.sh

Request a Feature or Open a Ticket

 

Ready To Get Started?