Sign inTry Free

Install SingleStore Flow

On this page

This section contains instructions for installing Ingest and XL Ingest, and license information.

To use Ingest and XL Ingest, install the products and provide the product IDs to either team@singlestore.com or your account representative to obtain either a paid license or a Developer trial license.

Prerequisites

While the database prerequisites will vary based on the source, the following are the minimum requirements for using both Ingest and XL Ingest.

Component

Requirements

Virtual Machine (VM)

The sizing recommendation is based on the size of databases/tables being transferred.

For smaller databases sized 100GB or less, a minimum of 2 vCPUs, 8 GB RAM, and 100 GB of free disk space is recommended.

For large transfers, more disk space may be required. The required free space for Ingest is twice the size of the largest table to be transferred.

For very large tables, where XL Ingest must be used, the amount of local disk needed is 2 x (logical partition size) x (number of concurrent partition transfers).

More CPU cores and RAM is required for sources and destinations that contain a large amount of data and have an aggressive timeline in which to transfer it.

The VM must be close to the source database to minimize latency.

Refer to the Recommended Hardware Configuration section in the Ingest documentation for more information.

Browser

A Chromium-based browser, such as Google Chrome or Microsoft Edge, installed on the VM

Java

Amazon Corretto Java 21, a no-cost distribution of the Open Java Development Kit (OpenJDK), installed on the VM

Install Ingest

You can install Ingest in both Windows and non-Windows environments.

Install Ingest as a Windows Service

Note: Filenames may change from release to release.

  1. Download and unzip the Ingest ZIP file:

    https://bryteflow.com/release/singlestore/ingest/417-9f09aa2/ingest.zip

  2. Change the directory to the ingest folder and open the ingest.xml file in a Notepad. Change the following lines as per your requirements.

    <id>SingleConnect-Ingest</id>

    This tag is used as an unique ID in Windows services.

    Each Ingest pipeline has its own ID.

    <name>SingleConnect Ingest</name>

    This tag is a display name in the Windows services.

    It must be brief but descriptive.

    <description>SingleConnect Ingest</description>

    This tag specifies a description of the Ingest service.

  3. Install Ingest as a Windows service.

    1. Open a command prompt as an Administrator.

    2. Change the current directory to the ingest folder and run the Install-Service.bat file using the following command.

      Install-Service.bat

      This batch file runs commands to install the service. Once the command is completed, close the command prompt.

  4. The Ingest service must appear in the Windows services list like SingleConnect-Ingest. The name must be similar as shown in step 2.

  5. The Ingest service starts automatically upon installation and must be running. You can start, stop, or restart the Ingest service similar to other Windows services.

  6. Open Chrome and navigate to http://localhost:8081. If the application is installed on a server, navigate to http://<server-name-or-IP-address>:8081 instead.

  7. Navigate to Settings > License and enter the license key.

Install Ingest in Non-Windows Environment

  1. Download and unzip the Ingest ZIP file:

    https://bryteflow.com/release/singlestore/ingest/417-9f09aa2/ingest.zip

  2. To start Ingest, run the following Java command from the directory where the files have been unzipped. To include external libraries, skip to the next step.

    java -jar ingest.jar

  3. To include external libraries, run the following command instead.

    Windows 

    java -cp "other_lib.jar;ingest.jar" org.springframework.boot.loader.JarLauncher

    Linux 

    java -cp "other_lib.jar:ingest.jar" org.springframework.boot.loader.JarLauncher

  4. The default port for Ingest is 8081. You can change this port from the user interface (UI). The new port setting takes effect after the next run.

Install XL Ingest

You can install XL Ingest in both Windows and non-Windows environments.

Note: Filenames may change from release to release.

Install XL Ingest as a Windows Service

  1. Download the XL Ingest ZIP file:

    https://bryteflow.com/release/singlestore/ixl/24_b1257/xlingest.zip

    Unzip the file into a directory at the same level as the Ingest directory.

  2. Change the directory to the xlingest folder and open xlingest.xml file in a Notepad. Change the following lines as per your requirements.

    <id>SingleConnect-XL-Ingest</id>

    This tag is used as an unique ID in Windows services.

    Each XL Ingest pipeline has its own ID.

    <name>SingleConnect XL Ingest</name>

    This tag is a display name in the Windows services.

    It must be brief and descriptive.

    <description>SingleConnect XL Ingest</description>

    This tag specifies a description of the XL Ingest service.

  3. Install XL Ingest as a Windows service.

    1. Open a command prompt as an Administrator.

    2. Navigate to xlingest folder and run the Install-SingleConnect-XL-Ingest-Service.bat file using the following command.

      Install-SingleConnect-XL-Ingest-Service.bat

      This batch file runs commands to install the service. Once the command is completed, close the command prompt.

  4. The XL Ingest service must appear in the Windows services list like SingleStore-XL-Ingest. The name must be similar as shown in step 2.

  5. The XL Ingest service starts automatically upon installation and must be running. You can start, stop, or restart the XL Ingest service like other Windows services.

  6. Open Chrome and navigate to http://localhost:8084. If the application is installed on a server, navigate to http://<server-ip-address>:8084 instead.

  7. Navigate to Configuration > License, and enter the license key.

Install XL Ingest in Non-Windows Environment

  1. Download the XL Ingest ZIP file:

    https://bryteflow.com/release/singlestore/ixl/24_b1257/xlingest.zip

    Unzip the file into a directory at the same level as the Ingest directory.

  2. To start XL Ingest, run the following Java command from the directory where the files have been unzipped. To include external libraries, skip to the next step.

    java -jar xlingest.jar

  3. To include external libraries, use the following command instead.

    Windows 

    java -cp "other_lib.jar;xlingest.jar" cirus.Run

    Linux 

    java -cp "other_lib.jar:xlingest.jar" cirus.Run

  4. The default port for XL Ingest is 8084. You can change this port from the user interface (UI). The new port setting takes effect after the next run.

Apply the License Key

The Flow suite of products comes with a validity period specific to each customer's agreement. You must obtain valid license keys to begin using the software. For learning and evaluation purposes, a free license with usage limits is available, refer to Free Trial Access to Flow for more details.

Licenses specify a maximum capacity in units. To transfer data to a SingleStore destination, the capacity of the Ingest license must be at least equal to the number of capacity units in the destination.

Each software product has its own unique product ID when set up individually. To obtain a valid license, contact SingleStore Sales with the Product ID.

For Ingest, go to Settings > Licence. In Licence Key, enter the license key, and then select Apply to save the settings.

To retrieve the Product ID, go to your Ingest instance, go to Settings > Licence, and copy the ID from the 'Product Id'.

For XL Ingest, go to Configuration. In Licence Key, enter the license key, and then select Save to save the settings.

To retrieve the Product ID, go to your XL Ingest instance, go to Configuration > Licence, and copy the ID from the 'Product Id'.

Last modified: September 16, 2025

Was this article helpful?

On this page

Was this article helpful?

Verification instructions

Note: You must install cosign to verify the authenticity of the SingleStore file.

Use the following steps to verify the authenticity of singlestoredb-server, singlestoredb-toolbox, singlestoredb-studio, and singlestore-client SingleStore files that have been downloaded.

You may perform the following steps on any computer that can run cosign, such as the main deployment host of the cluster.

  1. (Optional) Run the following command to view the associated signature files.

    curl undefined

  2. Download the signature file from the SingleStore release server.

    • Option 1: Click the Download Signature button next to the SingleStore file.

    • Option 2: Copy and paste the following URL into the address bar of your browser and save the signature file.

    • Option 3: Run the following command to download the signature file.

      curl -O undefined

  3. After the signature file has been downloaded, run the following command to verify the authenticity of the SingleStore file.

    echo -n undefined |
        cosign verify-blob --certificate-oidc-issuer https://oidc.eks.us-east-1.amazonaws.com/id/CCDCDBA1379A5596AB5B2E46DCA385BC \
          --certificate-identity https://kubernetes.io/namespaces/freya-production/serviceaccounts/job-worker \
          --bundle undefined \
          --new-bundle-format -
    Verified OK