2.3 Get Started with Local Install

You can install TDengine IDMP locally on a Linux, macOS, or Windows machine.

2.3.1 System Requirements

Ensure the following prerequisites are in place before installing:

• The latest version of TDengine TSDB-Enterprise must be installed and running. See Deploy from Package.
• Java 21 or later
• On Linux: glibc 2.28 or later
• SMTP email service (required for alert notifications; deploy internally if internet access is unavailable)
• A correctly configured system timezone. Refer to your operating system's user manual for instructions.

For full hardware and OS requirements, see Planning Your Deployment.

2.3.2 Install TDengine IDMP

Linux-Generic

1. Download the installation package from the following link:

2. Run the following commands to extract and install (using x64 architecture as an example):

   tar zxvf tdengine-idmp-enterprise--linux-x64.tar.gz
   cd tdengine-idmp-enterprise-
   sudo ./install.sh

   tip

   Your machine must be connected to the internet when you install TDengine IDMP. Dependencies are downloaded and installed during the installation process.

3. Configure the TDengine TSDB-Enterprise connection:

   Open /usr/local/taos/idmp/config/application.yml in a text editor and set the connection details under tda.default-connection:

   tda:
     default-connection:
       enable: true
       auth-type: UserPassword
       url: http://localhost:6041
       username: root
       password: taosdata

4. (Optional) Test the connection to TDengine TSDB-Enterprise:

   curl --request POST \
     --user root:taosdata \
     --url http://localhost:6041/rest/sql \
     --data 'show databases;'

   If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

5. Start TDengine IDMP:

   sudo svc-tdengine-idmp start

Linux-Red Hat

1. Download the installation package from the following link:

2. Run the following command to install the rpm package (using x64 architecture as an example):

   sudo rpm -ivh --nodeps tdengine-idmp-enterprise--linux-x64.rpm

   tip

   Your machine must be connected to the internet when you install TDengine IDMP. Dependencies are downloaded and installed during the installation process.

3. Configure the TDengine TSDB-Enterprise connection:

   Open /usr/local/taos/idmp/config/application.yml in a text editor and set the connection details under tda.default-connection:

   tda:
     default-connection:
       enable: true
       auth-type: UserPassword
       url: http://localhost:6041
       username: root
       password: taosdata

4. (Optional) Test the connection to TDengine TSDB-Enterprise:

   curl --request POST \
     --user root:taosdata \
     --url http://localhost:6041/rest/sql \
     --data 'show databases;'

   If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

5. Start TDengine IDMP:

   sudo svc-tdengine-idmp start

Linux-Ubuntu

1. Download the installation package from the following link:

2. Run the following command to install the deb package (using x64 architecture as an example):

   sudo dpkg -i tdengine-idmp-enterprise--linux-x64.deb

   tip

   Your machine must be connected to the internet when you install TDengine IDMP. Dependencies are downloaded and installed during the installation process.

3. Configure the TDengine TSDB-Enterprise connection:

   Open /usr/local/taos/idmp/config/application.yml in a text editor and set the connection details under tda.default-connection:

   tda:
     default-connection:
       enable: true
       auth-type: UserPassword
       url: http://localhost:6041
       username: root
       password: taosdata

4. (Optional) Test the connection to TDengine TSDB-Enterprise:

   curl --request POST \
     --user root:taosdata \
     --url http://localhost:6041/rest/sql \
     --data 'show databases;'

   If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

5. Start TDengine IDMP:

   sudo svc-tdengine-idmp start

macOS

1. Download the installation package from the following link:

2. Run the following command to install TDengine IDMP:

   sudo installer -pkg tdengine-idmp-enterprise--macos-arm64.pkg -target /

   tip

   Your machine must be connected to the internet when you install TDengine IDMP. Dependencies are downloaded and installed during the installation process.

3. Configure the TDengine TSDB-Enterprise connection:

   Open /usr/local/taos/idmp/config/application.yml in a text editor and set the connection details under tda.default-connection:

   tda:
     default-connection:
       enable: true
       auth-type: UserPassword
       url: http://localhost:6041
       username: root
       password: taosdata

4. (Optional) Test the connection to TDengine TSDB-Enterprise:

   curl --request POST \
     --user root:taosdata \
     --url http://localhost:6041/rest/sql \
     --data 'show databases;'

   If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

5. Start TDengine IDMP:

   sudo svc-tdengine-idmp start

Windows

1. Download the installation package from the following link:

2. Double-click the downloaded .exe installation package and follow the installation wizard to complete the installation.

   note

   Administrator privileges are required. If you encounter permission issues, right-click the installer and select Run as administrator.

   Dependencies

   TDengine IDMP on Windows requires:

   • Java 21 or higher, with the java command available in the system PATH environment variable
   • To verify that Java is properly configured, run java -version in the command prompt

3. After installation, TDengine IDMP related services will be automatically registered as Windows services.

   The default installation path is C:\TDengine\idmp.

4. Configure the TDengine TSDB-Enterprise connection:

   Open C:\TDengine\idmp\config\application.yml in a text editor and set the connection details under tda.default-connection:

   tda:
     default-connection:
       enable: true
       auth-type: UserPassword
       url: http://localhost:6041
       username: root
       password: taosdata

5. (Optional) Test the connection to TDengine TSDB-Enterprise:

   curl --request POST \
     --user root:taosdata \
     --url http://localhost:6041/rest/sql \
     --data 'show databases;'

   If the connection is successful, the list of databases in TDengine TSDB-Enterprise will be displayed.

6. Run the following batch file as an administrator to start TDengine IDMP:

   C:\TDengine\idmp\bin\start-tdengine-idmp.bat

   Or start the tdengine-idmp, tdengine-idmp-h2, and tdengine-idmp-chat services through Windows Service Manager.

2.3.3 Activate and Initialize the System

1. In a web browser, access TDengine IDMP at http://ip:6042.

2. Under Activate TDengine IDMP, enter your email address and organization.

3. Click Get Code and enter the code sent to your email address.

   tip

   If the email does not arrive, check your spam or junk folder.

4. Read the User Agreement and Privacy Policy and click Activate.

5. In the Privacy Settings dialog, select which diagnostic information you want to share with TDengine, then click Agree.

2.3.4 Enter Account Information

1. Enter your name, phone number, position, and password.

   note

   • Your password must be 8 to 20 characters long.
   • Your password must contain letters, digits, and special characters.
   • Supported special characters: . ~ ! @ # $ ^ & *

2. (Optional) Select a profile picture. JPG and PNG files under 1 MB are supported.

3. Click Continue.

Your TDengine IDMP instance is now ready to use. Continue to Section 2.4 to load sample data and explore IDMP features.