Skip to main content

Installer

Download and run TimeBase Community Edition Installer. Follow a few simple steps to setup TimeBase Community Edition on your machine. You can also install TimeBase in Docker by following our Quick Start guide.

tip

TimeBase Installer requires Java 11 or newer to be installed on your machine.

Step 1: Launch Installation​

  1. Execute jar installation file to run TimeBase installation wizard.

  2. You can also launch TimeBase installation by running this command from the installation file root folder: 

    java -jar installation-file-name.jar

  3. Click Next to proceed to the next step.

Step 2: Licensing​

Accept the Apache open source license agreement to proceed with Community Edition installation.

Step 3: Installation​

Select TimeBase installation folder to store all TimeBase system files.

Step 4: TimeBase Components​

Along with TimeBase Server you can install a TimeBase Web Gateway and TimeBase Web Admin. Select Web Gateway to install both.

  • Web Admin - Web application for TimeBase administration. Refer to Admin Guide for details.
  • Web Gateway - REST/WS client for TimeBase Server. See API Reference

Step 5: Start TimeBase​

Once TimeBase components are installed, you can start TimeBase Server.

  1. Specify Home folder. Home folder stores data, launching scripts, configs, logs of the running application. From a single installation folder it is possible to run multiple processes, each having a personal Home folder.
  2. Assign a free port for TimeBase.
  3. Start TimeBase (select one of the running options)
    • Run as service - TimeBase as a service is suitable for a continuous usage and on remote machines.
    • Run in terminal - runs in a console. Process ends as window closes. Suitable for local tests.
  4. Click Run TimeBase to start TimeBase.
  5. In case you run TimeBase as a service, you can click a Trash can icon to stop and uninstall this service.
  6. Click Next to proceed and launch TimeBase Web Admin or Finish to end installation on this step.
tip

Successfully started TimeBase has status RUNNING.

When you click Run TimeBase, you get a ready-to-go sample data added to the Home folder that you have specified in this step. This is an example data and serves for demonstration purposes.

Step 6: Web Gateway Setup​

In this step, TimeBase Installer allows you to launch a Web Gateway - REST/WS gateway for TimeBase Server. Web Gateway is also a TimeBase Web Admin, data management and monitoring Web application.

  1. Specify port for the Web Gateway. Displayed TimeBase port indicates on a specific TimeBase instance your Web Gateway will be working with (you may have multiple TimeBase instances running).
  2. Click Run Gateway to run application in terminal.
  3. Once application has started, you can click Open in browser to open TimeBase Web Admin application in browser. Web Admin displays streams with sample data from the Home folder (see previous step).
  4. Click Finish to end the installation process or Previous to return the the previous step.

Hardware Recommendations for TimeBase​

  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. High Clock Speed: For workloads with complex queries or high-frequency data, prioritize CPUs with higher clock speeds to reduce latency.

  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.

  5. 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, CentOS, 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.
  1. 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:

TimeBase Executable:
Add the TimeBase installation folder to the `Defender` exclusion list.

Data and Log Directories:
Exclude the directories where TimeBase stores its data and log files. Usually `TimeBase Home`.

Backup Locations:
If you use scheduled backups, exclude backup directories to prevent scan delays.

How to Add Exclusions in Windows Defender:

Open Windows Security.
Go to Virus & threat protection > Manage settings.
Scroll to Exclusions and select Add or remove exclusions.
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:

Exclude TimeBase Executable and Service Paths:
Add the TimeBase binary and service directories to your antivirus exclusion list 

Exclude Data and Log Directories:
Exclude the directories where TimeBase stores its data and logs

Backup Locations:
Exclude backup directories from real-time scanning.

How to Add Exclusions (Example for ClamAV):

Edit the ClamAV configuration file (e.g., /etc/clamav/clamd.conf) and add:

ExcludePath ^/opt/timebase-home    

Restart the ClamAV service after making changes.

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

What Is Next​

TimeBase Shell​

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

Launch tickdb.cmd from bin TimeBase folder to open TimeBase Shell. Run ? to get a list of available commands.

Solution Generator​

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

Samples​

info

Refer to Client Libraries for more information.