Sign inTry Free

Install Ingest

On this page

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/41-b643/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/41-b643/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.

Apply the License Key

The Flow suite of products comes with a validity period specific to each customer's agreement. Be sure to obtain valid license keys to begin using the software. 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. Navigate 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, navigate to Settings > Licence, and copy the ID from the 'Product Id'.

Upgrade Ingest

Use the following steps to upgrade Ingest without losing connection settings, current progress, or scheduled operations.

  1. Confirm that Ingest is not currently running an extract.

    If no extracts are running, turn off the scheduler.

    1. Navigate to the Dashboard tab. Under Schedule, disable the scheduler and wait for the load to complete.

    2. Open Windows Services and stop the Ingest Windows service.

  2. Change to the current Ingest installation directory.

  3. Rename the ingest.jar file to something else, such as ingest.jar.<date>, where <date> is the date on the .jar file.

  4. Download and unzip the latest Ingest ZIP file:

    https://bryteflow.com/release/singlestore/ingest/41-b643/ingest.zip

  5. Move this ZIP file's ingest.jar file to the current Ingest folder.

  6. Navigate to the Dashboard tab, under Schedule, and enable the scheduler.

Last modified: February 7, 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