QSCIM Designer Local Installation

Created by QriarLabs Support, Modified on Fri, 28 Jun at 11:43 PM by Edgar Silva


The QSCIM platform helps organizations integrate their identity repositories, synchronizing information, entitlements, etc.


We can separate QSCIM into 2 different outlooks: 

  • Designer - The integration designer tool, where users can define, configure, and generate integration microservices.
  • Runtimes—The designer's generated microservices are a Node.js Microservice Docker image that can be executed in any container environment. 


To install the QSCIM Designer locally, we must have a dedicated VM where we will must have the following requirements: 


  • A VM (EC2 instance / Cloud node instance) 
  • Full SSH Root access or sudo permission just for this machine
  • Ubuntu 22 LTS 
  • We will install the following software:
    • Docker Runtime
    • Docker compose 
    • Execute a compose that will start: 
      • MongoDB
      • PostgreSQL 
      • QSCIM REST API Services (Restheart) - Java Container
      • QIAM - The Internal IDP for QSCIM - Java Container
      • QSCIM Designer - Node.js Container 
      • The execution will enable a Let's Encrypt certificate; the whole communication is done internally in this self-contained VM.
      • The VM should be able to access our Container's registry in the Google Cloud Registry and/or GitHub Registry. 
      • This VM must have access to the internal services (databases, ldaps, Active Directories, APIs etc).
  • According to the customers, we know we shall have some security points we could adapt.
  • Ideally, the QSCIM Designer can be executed from our Cloud currently hosted in GCP. 


Minimum Hardware Requirements:


As a starting point, for a lightweight QSCIM workspace, the minimum hardware could be relatively modest. To support over 50 requests per second (50rps) with an average 10KB payload, we recommend at least a VM/Node with the following configuration:


CPU: Minimum 4 cores, with modern architecture (the faster, the better, especially for high-concurrency workloads).


Memory: At least 4GB of RAM is recommended, though 8GB or more is better for better caching and handling of node processes.


Disk: SSD for faster I/O operations. Over 20 GB is enough, especially if the QSCIM docker runtime instance relies on frequent disk access or local caching.


Want to know more about QSCIM:  https://qriarlabs.com/qscim/ 

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article