2.1.0 Windows installation

Welcome to the quilliup installation tutorial for Windows

Quilliup runs on Apache Tomcat and requires a compatible Java Runtime Environment (JRE). This tutorial provides step-by-step guidance for installing and configuring Quilliup on Windows.

Prerequisites

Before starting, ensure the following:

• Review the quilliup Prerequisites. 

• The user performing the installation must have Administrator permissions.

• Prepare an empty database to serve as the Quilliup repository.

⚠️ Note: Avoid schema names containing /, \, or other special characters.

• Confirm the DB user has CREATE, ALTER, and EXECUTE permissions on the Quilliup repository database.

• Request and download the latest Quilliup installation WAR file by opening a support ticket: How to Open a Ticket for the quilliup Support Team 

Follow the next steps:

1. Download and install recommended Java version:

How to download and install Java

2. Download and install recommended Apache Tomcat version: How to download and install Apache Tomcat

Note: after Step 2, you will have the quilliup service installed!

Configure 3 relevant ports in the server.xml file:

•  

  • Shutdown: e.g., 8005

  • AJP: e.g., 8006

  • HTTP: 8080 or HTTPS: 8443/443

Verify that catalina.bat and service.bat files contain the required parameters (memory limits, DDs cache, etc.).

3. Stop the Service

• Open Task Manager.

• Locate the Apache Tomcat {version} Quilliup service.

• Right-click → End Task.

• Confirm in Services that the service is fully stopped.

 

4. Delete all the log files from the "..\quilliup\logs" folder.

 

5. Delete the "Catalina" folder from the "...\quilliup\work" folder.

Ensure ..\quilliup\webapps does not contain a ROOT folder, ROOT.war, or other .war files. If present, delete them.

 

6. Deploy the Application

• Copy the downloaded .war file into folder ..\quilliup\webapps

• Rename it to: ROOT.war

⚠️ Make sure the name ROOT is uppercase.

7.Run the Service

• From Services, start the quilliup service.

• Wait a few minutes, then check the log: ..\quilliup\logs\quilliup-stderr.log

• Confirm the startup message appears: org.apache.catalina.startup.Catalina.start Server startup in "XXX" ms

8. Repeat steps 3-5 (stop the service, delete log files and the "Catalina" folder).

9. Configure Repository Connection

• Open:..\quilliup\webapps\ROOT\WEB-INF\classes\connection.properties

• Define repository details:

  1. Uncomment your DB repository type.

  2. Update connection.jdbcUrl parameter's value.

  3. Set username and password parameters to correct values.

  4. Adjust any other parameters as needed.

10. Configure UI Settings:

• Open: ..\quilliup\webapps\ROOT\WEB-INF\classes\config.properties in edit mode

• Define relevant parameters:

  • server.ip → environment IP/hostname

  • company.name → tenant name

  • server.port → port number

  • server.protocol → change to HTTPS if needed

  Set the memory of quilliup by the manual Set up quilliup server allowed memory values

 

11. License Activation

(1) Start the service and access quilliup via the configured IP in your browser.

(2) In the browser try accessing quilliup's UI using the IP address set in the config.properties file.

You will be required to provide valid quilliup license details:

Provide license details:

Option 1- Online Activation:

a. Copy the license key from email 

b. paste into activation window

c. click Activate.

Option 2- Offline Activation:

a. Click Offline Activation.

b. Copy the computerID parameter.

c. Open a support ticket- How to Open a Ticket for Support or email [e-mail] to request a license.

d. Save the received file as quilliupLicense.xml in the path specified in the activation window.

e. Refresh the browser (no service restart required).

 

12. Log in quilliup UI

After you get your license, in the browser try to log into quilliup's UI using the IP address set in the config.properties file. log in with default credentials:

• Username: admin

• Password: admin

13. Additional Configurations

(1) How to switch HTTPS mode? Set up an HTTPS

(2) How to connect via Active Directory mode?

a. Define the settings via quilliup's UI: Active Directory connection settings

b. Add one or two users for testing.

c. Configure Kerberos or Jespa:

•  

  • Kerberos: Connect quilliup to Active Directory using Kerberos Spnego

  • Jespa: Set up quilliup to work in Active Directory AD mode using Jespa

d. Modify web.xml in: ..\quilliup\webapps\ROOT\WEB-INF

• Repeat steps 3–5 (stop service, delete logs, delete Catalina folder).

(3) How to disable dropdown cache: RDA module, Drop Down's Cache