Skip to main content

Installer

tip

You can also install TimeBase in Docker by following our Quick Start guide.

Prerequisites​

Platform​

The installer supports Windows, Linux, and MacOS platforms.

For production deployments it's recommended to use the latest versions of 64-bit Windows Server and enterprise-grade Linux distributions (e.g., Ubuntu LTS or RHEL). See the Hardware & OS Recommendations section for details.

Java​

To run the installer, you must have Java Runtime Environment version 11 or above installed.

You can check the installed Java version by running the following command in your terminal:

java -version
note

Installer versions prior to 5.6.186 don't support JRE 21 or newer.

Getting Installer​

Choose an installer based on your platform:

Windows​

deltix-windows-installer-online-<version>.jar

Linux & MacOS​

deltix-linux-installer-online-<version>.jar

Installer Modes​

caution

Installer versions prior to 5.6.186 require administrator privileges to run. To find out how to run the installer without admin rights, refer to the Administrator Privileges section.

Default Mode​

Run the installer jar without parameters.

java -jar deltix-<platform>-installer-online-<version>.jar

If you have a GUI-based operating system, the installer opens in the User Interface (UI) mode. For instructions on using UI mode for installation, see the UI Installer section.

Console Mode​

If you have a headless operating system, the installer opens in console mode. For instructions on using console mode for installation, see the Command Line Installer section.

To launch console mode manually use the -console parameter:

java -jar deltix-<platform>-installer-online-<version>.jar -console

Automation Mode​

If you already have an installation script (auto-install.xml) generated from a previous installation, you can run the installer in automation mode by specifying the script as a parameter:

java -jar deltix-<platform>-installer-online-<version>.jar auto-install.xml

See the Automation Mode section for details on generating and using the installation script.

UI Installer​

Use the following procedure to set up TimeBase on your machine.

Step 1: Launch Installation​

  1. If you haven't already, execute the following command:

    java -jar deltix-<platform>-installer-online-<version>.jar

    The welcome window appears.

  2. Click Next.

Step 2: Licensing​

Accept the license agreement and click Next.

Step 3: Installation​

  1. Select the TimeBase installation folder and click Next.
note

If you want to install TimeBase into a protected directory, e.g., C:\Program Files or /opt/, make sure to run the installer with administrator privileges.

  1. Enter your license key.
  1. Specify a JDK and an installation name.
caution

Currently, only JDK 11 and 17 are supported.

Step 4: Deltix Components​

  1. Select other Deltix products you wish to install.

    Visit a dedicated page to learn more about WebAdmin.

  2. Click Next to run the installation.

Step 5: Run TimeBase​

You have the option to save your selections for future installations by generating an automatic installation script. For more information on this option, see the Automation (Silent) Mode section.

Once the installation completes successfully, you can launch QuantServer Architect.

Check out the Next Steps & References for more resources on using TimeBase.

Command Line Installer​

This section provides instructions on launching the command line installer, as well as the prompts you'll encounter in the installer along with the recommended responses.

Step 1: Launch Console​

To launch the command line installer, just add a -console flag when running the installer jar:

java -jar deltix-<platform>-installer-online-<version>.jar -console

Step 2: Target Path​

When prompted for an installation path:

  • If you are installing TB for the first time, manually enter the desired path or leave the default, e.g., C:\Deltix\<version> on Windows.
note

If you want to install TimeBase into a protected directory, e.g. C:\Program Files or /opt/, make sure to run the installer with administrator privileges.

  • If you have performed an installation before, the previous path automatically appears.
Select the installation path: []
C:\Deltix\5.6.176
-------------------------------------------------
Message

The target directory will be created:
C:\Deltix\5.6.176
-------------------------------------------------
Enter O for OK, C to Cancel:
O

Press 1 to continue, 2 to quit, 3 to redisplay
1

Step 3: Serial Number & JDK​

  1. When prompted for a serial number:

    • If you are installing TB for the first time, manually enter the serial number provided to you by the Deltix team.
    • If you have performed an installation before, the previous serial number automatically appears.
    Serial number: [****]

  2. Enter 0 to decline the HTTP proxy and 1 to continue.

    [ ] Use HTTP Proxy to connect license server
    Enter 1 to select, 0 to deselect:
    0

    Press 1 to continue, 2 to quit, 3 to redisplay
    1

  3. Choose a JDK by entering the corresponding number.

caution

Currently, only JDK 11 and 17 are supported.

You can download JDK from https://adoptopenjdk.net
Specify JDK:
0  [x] Not Specified
1  [ ] + Add JDK
2  [ ] JDK 11.0.11.9 (C:\Program Files\Java\jdk-11.0.11+9)
3  [ ] JDK 11.0.17.8 (C:\Program Files\Java\jdk-11.0.17+8)
4  [ ] JDK 17.0.1.12 (C:\Program Files\Java\jdk-17.0.1)

Step 4: Installation Name​

Since you can have several installations at the same time, it's recommended to specify the installation version in the installation name.

Specify Installation Name:
 [5.6.176]
5.6.176
The Installation Name will be used to label program menu items, desktop shortcuts and OS services.
Leave empty to use default Installation Name.

Press 1 to continue, 2 to quit, 3 to redisplay
1

Step 5: Installation Packages​

caution

Selecting Y for the QuantServer pack is required.

Select the packs you want to install:

-----------------------------------------
  [x] Include pack 'QuantServer'
-----------------------------------------
Enter Y for Yes, N for No:
y
--------------------------------------
  [x] Include optional pack 'WebAdmin'
--------------------------------------
Enter Y for Yes, N for No:
y
Done!

Press 1 to continue, 2 to quit, 3 to redisplay
1

Step 6: Finish Installation​

Your installation is confirmed.

====================
Installation started
Framework: 5.1.3-84aaf (IzPack)
Platform: windows,version=10.0,arch=x64,symbolicName=WINDOWS_10,javaVersion=11.0.17
[ Starting to unpack ]
[ Processing package: QuantServer (1/2) ]
Cleaning up the target folder ...
[ Processing package: WebAdmin (2/2) ]
Cleaning up the target folder ...
[ Unpacking finished ]
Installation finished

You have the option to save your selections for future installations by generating an automatic installation script. For more information on this option, see the Automation (Silent) Mode section.

-----------------------------------------
Generate an automatic installation script
-----------------------------------------
Enter Y for Yes, N for No:
Y

Check out the Next Steps & References for more resources on using TimeBase.

Additional Parameters​

Logging​

The installer automatically writes the log file into the installation_directory/install.log file.

To specify a log file, use the -logfile <log_file_path> command-line parameter:

java -jar deltix-<platform>-installer-online-<version>.jar -logfile <log_file_path>

You can also pass a logging configuration file as system property to the JVM calling the installer:

java -Djava.util.logging.config.file=<log.properties> -jar deltix-<platform>-installer-online-<version>.jar

Administrator Privileges​

note

This parameter is only relevant for installer versions prior to 5.6.186, which require administrator privileges to run.

The QS_INSTALL_UNPRIVILEGED property determines the privilege level required to run the installer. By default, running the installer requires administrator privileges.

To allow users to run the installer without admin rights, set QS_INSTALL_UNPRIVILEGED to true.

  • On Linux, use:
export QS_INSTALL_UNPRIVILEGED=true
  • On Windows, use:
set QS_INSTALL_UNPRIVILEGED=true

To enforce admin privileges to run the installer, set the property to false.

Automation Mode​

On the last installation step, you have an option to generate an installation script (auto-install.xml file), which the automation mode uses for future installations.

Automation mode silently runs the installer and retains the choices you made during the original installation. You can use this mode to deploy Deltix products on multiple machines.

Save Automation Script​

If using the interactive UI installer:

  • On the Installation Finished step, click Generate an automatic installation script.

If using the command-line installer:

  • On the Installation Finished step, respond Y to the following prompt.

    -----------------------------------------
    Generate an automatic installation script
    -----------------------------------------
    Enter Y for Yes, N for No:
    Y

Run Automation Mode​

To run the automation mode, specify auto-install.xml (the properties file for automation mode) to the installer jar as a command-line parameter:

java -jar deltix-<platform>-installer-online-<version>.jar auto-install.xml

Hardware & OS Recommendations​

Hardware​

  1. CPU

    • Multi-core Processors: TimeBase leverages multi-threading for data ingestion and query processing. For production deployments, select CPUs with at least 8 cores. Consider clock cycles, bus speed, and cache size when purchasing CPUs. A faster clock speed and faster bus speed typically result in faster performance. Larger cache sizes can also benefit performance.

  2. Memory (RAM)

    • Sufficient RAM: TimeBase benefits from large memory allocations for caching and indexing. A minimum of 32 GB RAM is recommended for moderate workloads; scale up to 128 GB or more for enterprise or high-frequency environments.
    • ECC Memory: Use ECC RAM in mission-critical deployments to prevent data corruption and ensure reliability.

  3. Storage

    • SSD/NVMe Drives: Fast storage is crucial for TimeBase’s real-time data ingestion and retrieval. Use enterprise-grade SSDs or NVMe drives for both data and log directories.
    • RAID Configuration: RAID 10 is recommended for a balance of performance and redundancy.
    • Capacity Planning: Estimate your data retention and ingestion rates to size storage appropriately, allowing for future growth.

  4. Network

    • High Throughput: Deploy at least 1 Gbps network interfaces; 10 Gbps is recommended for clustered or high-ingest environments.
    • Low Latency: Ensure low-latency networking, especially for distributed TimeBase clusters.

Operating System and Security​

  • Windows

    • 64-bit Windows Server: For Windows deployments, use a supported 64-bit Windows Server version for best compatibility and performance.
    • Regular Updates: Keep the OS and all drivers updated to maintain security and stability.
    • For low-latency setups make sure that all hardware is correctly tuned.

  • Linux

    • Supported Distributions: Use enterprise-grade distributions such as Ubuntu LTS or Red Hat Enterprise Linux.
    • Kernel Version: Ensure you are running a recent, supported kernel version for optimal hardware compatibility and security.
    • Regular Updates: Keep the OS and all packages updated, especially security patches.

Security Exclusions for TimeBase​

Windows Defender Whitelisting​

Windows Defender may impact TimeBase performance by scanning its executables and data directories. To avoid resource contention, whitelist the following:

  • Executables:

    • Add JDK home folder to Defender exclusion list.
    • Add the TimeBase installation folder to the Defender exclusion list.

  • Data Directories:

    • Exclude the directories where TimeBase stores its data and log files. Usually it's called TimeBase Home.

  • Backup Locations:

    • If you use scheduled backups, exclude backup directories to prevent scan delays.

How to Add Exclusions in Windows Defender:

  1. Open Windows Security.
  2. Go to Virus & threat protection > Manage settings.
  3. Scroll to Exclusions and select Add or remove exclusions.
  4. Add the relevant files, folders, or processes.

Linux Security Exclusions​

On Linux, real-time antivirus solutions (such as ClamAV, Sophos, or others) may also scan database files and impact performance. To avoid this:

  1. Exclude TimeBase Executable and Service Paths:

    Add the TimeBase binary and service directories to your antivirus exclusion list

  2. Exclude Data and Log Directories:

    Exclude the directories where TimeBase stores its data and logs

  3. Backup Locations:

    Exclude backup directories from real-time scanning.

How to Add Exclusions (Example for ClamAV):

  1. Edit the ClamAV configuration file (e.g., /etc/clamav/clamd.conf) and add:
ExcludePath ^/path/to/timebase-home
  1. Restart the ClamAV service after making changes.

For other antivirus solutions, refer to their documentation for exclusion configuration.

Next Steps & References​

Learn how to use QuantServer Architect​

Follow the guide to learn how to use QuantServer Architect.

Install TimeBase as a systemd Service on Linux​

For information on installing TimeBase as a systemd service on Linux, refer to the How To page.

TimeBase Shell​

Use TimeBase TickDB Shell CLI to work with streams and run various maintenance and operational commands.

Solution Generator​

Use TimeBase Solution Generator (Solgen) to generate ready-to-go code samples in several supported languages.

Samples​

For available samples, refer to the Client Libraries page.