# Install SingleStore Flow 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](mailto: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](https://docs.singlestore.com/db/v9.1/load-data/load-data-with-singlestore-flow/singlestore-ingest/#section-idm234737713970451.md)section in the Ingest documentation for more information. | | Browser | A Chromium-based browser, such as[Google Chrome](https://www.google.com/chrome/)or[Microsoft Edge](https://www.microsoft.com/en-us/edge/), installed on the VM | | Java | [Amazon Corretto Java 21](https://docs.aws.amazon.com/corretto/latest/corretto-21-ug/downloads-list.html), 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 the following files to your host: * Ingest JAR: * Ingest Setup ZIP: 2. Unzip the Ingest setup ZIP file. This creates an `ingest` directory. 3. Move the `ingest` directory to your desired install location. For example, `C:\SingleStore\ingest`. 4. Copy the downloaded `ingest.jar` file into the **ingest directory** so that all required files are in the same location. 5. Change the directory to the `ingest` directory and open the `ingest.xml` file in a Notepad. Change the following lines as per your requirements. | `SingleConnect-Ingest` | This tag is used as a unique ID in Windows services.EachIngestpipeline has its own ID. | | ------------------------------------------------- | -------------------------------------------------------------------------------------- | | `SingleConnect Ingest` | This tag is a display name in the Windows services.It must be brief but descriptive. | | `SingleConnect Ingest` | This tag specifies a description of theIngestservice. | **Note**: When a server hosts several Java versions, relying on the system’s default Java can result in version conflicts or unexpected failures. To guarantee Ingest uses the intended Java version, refer the full path to your required Java binary directly.  For example, if Java 21 has been extracted to `C:\java\java21`, specify the absolute path to `java.exe` in your `ingest.xml` file: ```xml C:\java\java21\bin\java.exe ``` 6. Grant the following permissions to the user that runs the Ingest service, on the entire Ingest directory: * Read * Write * Delete Ensure that all contained files and subfolders get the same permissions. 7. Install Ingest as a Windows service. 1. Open a command prompt as an Administrator. 2. Change the current directory to the `ingest` directory and run the `Install-Service.bat` file using the following command. ```shell Install-Service.bat ``` This batch file runs commands to install the service. Once the command is completed, close the command prompt. 8. The Ingest service must appear in the Windows services list like `SingleConnect-Ingest`. The name must be similar as shown in step 2. 9. 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. 10. Open Chrome and navigate to . If the application is installed on a server, navigate to `http://:8081` instead. 11. Navigate to **Settings** > **License** and enter the license key. ## Install Ingest in Non-Windows Environment 1. Download the following files to your host: * Ingest JAR: * Ingest Setup ZIP: 2. Unzip the Ingest setup ZIP file. This creates an `ingest` directory. 3. Move the `ingest` directory to your desired install location. For example, `/opt/singlestore/ingest`. 4. Copy the downloaded `ingest.jar` file into the **ingest directory** so that all required files are in the same location. 5. To start Ingest, run the following Java command from the `ingest` directory. To include external libraries, skip to the next step. ```shell java -jar ingest.jar ``` 6. To include external libraries, run the following command instead. **Windows** ```shell java -cp "other_lib.jar;ingest.jar" org.springframework.boot.loader.JarLauncher ``` **Linux** ```shell java -cp "other_lib.jar:ingest.jar" org.springframework.boot.loader.JarLauncher ``` 7. 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 following files to your host: * XL Ingest JAR: * XL Ingest Setup ZIP: 2. Unzip the XL Ingest setup ZIP file. This creates an `xlingest` directory. 3. Move the `xlingest` directory to your desired install location. For example, `C:\SingleStore\xlingest`. 4. Copy the downloaded `xlingest.jar` file into the **xlingest directory** so that all required files are in the same location. 5. Change the directory to the `xlingest` directory and open `xlingest.xml` file in a Notepad. Change the following lines as per your requirements. | `SingleConnect-XL-Ingest` | This tag is used as a unique ID in Windows services.EachXL Ingestpipeline has its own ID. | | ---------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `SingleConnect XL Ingest` | This tag is a display name in the Windows services.It must be brief and descriptive. | | `SingleConnect XL Ingest` | This tag specifies a description of theXL Ingestservice. | 6. Install XL Ingest as a Windows service. 1. Open a command prompt as an Administrator. 2. Navigate to `xlingest` directory and run the `Install-SingleConnect-XL-Ingest-Service.bat` file using the following command. ```shell Install-SingleConnect-XL-Ingest-Service.bat ``` This batch file runs commands to install the service. Once the command is completed, close the command prompt. 7. 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. 8. 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. 9. Open Chrome and navigate to . If the application is installed on a server, navigate to `http://:8084` instead. 10. Navigate to **Configuration** > **License**, and enter the license key. ## Install XL Ingest in Non-Windows Environment 1. Download the following files to your host: * XL Ingest JAR: * XL Ingest Setup ZIP: 2. Unzip the XL Ingest setup ZIP file. This creates an `xlingest` directory. 3. Move the `xlingest` directory to your desired install location. For example, `/opt/singlestore/xlingest`. 4. Copy the downloaded `xlingest.jar` file into the **xlingest directory** so that all required files are in the same location. 5. To start XL Ingest, run the following Java command from the `xlingest` directory. To include external libraries, skip to the next step. ```shell java -jar xlingest.jar ``` 6. To include external libraries, use the following command instead. **Windows** ```shell java -cp "other_lib.jar;xlingest.jar" cirus.Run ``` **Linux** ```shell java -cp "other_lib.jar:xlingest.jar" cirus.Run ``` 7. 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](https://docs.singlestore.com/db/v9.1/load-data/load-data-with-singlestore-flow/free-trial-access-to-flow.md) 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](https://www.singlestore.com/contact/) 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'**. *** Modified at: May 1, 2026 Source: [/db/v9.1/load-data/load-data-with-singlestore-flow/install-singlestore-flow/](https://docs.singlestore.com/db/v9.1/load-data/load-data-with-singlestore-flow/install-singlestore-flow/) (An index of the documentation is available at /llms.txt)