2.0.0 quilliup Prerequisites version 3.1

This document outlines the system prerequisites for installing quilliup (version 3.1) and its components.

 

1. Architecture Overview (Version 3.1)

Version 3.1 introduces a new architecture and provides two primary installation paths. It is crucial to select one path before preparing your environment.

1. Path A: Docker-based Installation (Recommended Path)

• This is our strategic and recommended path for production environments.
• It uses Docker containers running on a Linux Host operating system.
• Benefits: Simplified upgrades, better performance, improved environment isolation, and easier maintenance.

2. Path B: Standard Installation (Non-Docker)

• This path uses a standard installer on a Windows Server operating system.
• Note: This version (3.1) uses an embedded Tomcat server. It does not require (and does not support) an external Tomcat installation.

2. Path A: Linux-based Installation 

This installation requires a Linux Host OS to run quilliup

*quilliup can get deployed on Docker as well   

Host Server Requirements

Component	Development Server	Production Server
Host OS	Linux Only (e.g., RHEL 8.x, RHEL 9.x, Ubuntu, CentOS)	Linux Only (e.g., RHEL 8.x, RHEL 9.x, Ubuntu, CentOS)
CPU	8 Cores	12-16 Cores
Memory	16 GB	48 GB *
Disk Space	40 GB minimum (64 GB recommended)	80 GB minimum

 

Software & Networking

Component	Requirement
Software	• Java 21 JDK (Required for the embedded server- non Docker only)
Networking	• Ports 8080, 8443 (quilliup web) • Port 25 (SMTP Mail server)

Docker specific components

Component	Requirement
Software	• Docker Engine (Latest stable version) • Docker Compose (Latest stable version)
Networking	• Access from the host system to Docker Hub (for pulling images).

3. Path B: Standard Installation (Non-Docker)

This installation runs as a standard application on a Windows Server.

Architecture Detail: This path installs a native Windows Service. This service acts as a wrapper (using WinSW) which manages the core Java application (.jar) and serves all frontend files.

Host Server Requirements

Component	Development Server	Production Server
Host OS	Windows Server 2019 or Windows Server 2022	Windows Server 2019 or Windows Server 2022
CPU	8 Cores	12-16 Cores
Memory	16 GB	48 GB *
Disk Space	40 GB minimum (64 GB recommended)	80 GB minimum

Software & Networking

Component	Requirement
Software	• Java 21 JDK (Required for the embedded server)  • .NET Framework 4.5 or higher (For specific optional features)
Networking	• Ports 8080, 8443 (quilliup web) • Port 25 (SMTP Mail server)

4. Common Requirements (Applies to Both Paths)

The following components are required regardless of the installation path you choose.

quilliup Repository Database

This is the database that stores all quilliup metadata (projects, tests, users, etc.).

Database Type	Supported Versions
Oracle	11c - 19.23
SQL Server	2008 - 2019
MySQL	(Supported)

• Storage: 4 GB Minimum (Recommended: 4 GB + 2 GB Per Year)
• Permissions: The database user requires read/write/DDL permissions on the repository schema.

Supported Web Browsers

• Google Chrome (Latest version)
• Mozilla Firefox (Latest version)
• Microsoft Edge (Latest version)

Notes

• * The amount of memory may be affected by the number of concurrent users and tests.
• A user with administrator/root privileges is required for the installation process.