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.
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. For very large tables, where XL Ingest must be used, the amount of local disk needed is 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.
-
Download and unzip the Ingest ZIP file:
https://bryteflow.
com/release/singlestore/ingest/416-a8a074a/ingest. zip -
Change the directory to the
ingest
folder and open theingest.
file in a Notepad.xml 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.
-
Install Ingest as a Windows service.
-
Open a command prompt as an Administrator.
-
Change the current directory to the
ingest
folder and run theInstall-Service.
file using the following command.bat Install-Service.batThis batch file runs commands to install the service.
Once the command is completed, close the command prompt.
-
-
The Ingest service must appear in the Windows services list like
SingleConnect-Ingest
.The name must be similar as shown in step 2. -
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. -
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. -
Navigate to Settings > License and enter the license key.
Install Ingest in Non-Windows Environment
-
Download and unzip the Ingest ZIP file:
https://bryteflow.
com/release/singlestore/ingest/414-00d0934/ingest. zip -
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 -
To include external libraries, run the following command instead.
Windows
java -cp "other_lib.jar;ingest.jar" org.springframework.boot.loader.JarLauncherLinux
java -cp "other_lib.jar:ingest.jar" org.springframework.boot.loader.JarLauncher -
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
-
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.
-
Change the directory to the
xlingest
folder and openxlingest.
file in a Notepad.xml 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.
-
Install XL Ingest as a Windows service.
-
Open a command prompt as an Administrator.
-
Navigate to
xlingest
folder and run theInstall-SingleConnect-XL-Ingest-Service.
file using the following command.bat Install-SingleConnect-XL-Ingest-Service.batThis batch file runs commands to install the service.
Once the command is completed, close the command prompt.
-
-
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. -
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. -
Open Chrome and navigate to http://localhost:8084.
If the application is installed on a server, navigate to http://<server-ip-address>:8084
instead. -
Navigate to Configuration > License, and enter the license key.
Install XL Ingest in Non-Windows Environment
-
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.
-
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 -
To include external libraries, use the following command instead.
Windows
java -cp "other_lib.jar;xlingest.jar" cirus.RunLinux
java -cp "other_lib.jar:xlingest.jar" cirus.Run -
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.
Licenses specify a maximum capacity in units.
Each software product has its own unique product ID when set up individually.
For Ingest, go to Settings > Licence.
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.
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 5, 2025