Skip to main content

14.3.2 Local Deployment

This guide explains how to deploy TDengine IDMP with an installer package on Linux, macOS, or Windows.

To install TSDB, IDMP, TDgpt, and other modules together with a single command, use All-in-One deployment. See section 14.13.

14.3.2.1 Prerequisites​

warning

TDengine IDMP requires TDengine TSDB-Enterprise 3.4.1.7 or later. Install and start TDengine TSDB-Enterprise before installing TDengine IDMP.

Before installation, confirm the following:

  • TDengine TSDB-Enterprise 3.4.1.7 or later is installed and running. See Deploy with an installer package.
  • Java 21 or later (installed automatically by the install command)
  • glibc 2.28 or later (Linux only)
  • Microsoft Visual C++ Redistributable 14.44 or later (installed automatically by the install command; Windows only)
  • A stable internet connection
  • A correctly configured system time zone. See your operating system documentation.

For complete hardware and OS requirements, see Planning.

14.3.2.2 Install TDengine IDMP​

Follow the one-line install command provided for TDengine IDMP-Enterprise in the TDengine Download Center. Copy and paste it into a terminal to install.

tip

On Linux, run the command as root. On Windows, open an elevated PowerShell window as Administrator before running the command.

Common installation errors​

IDMP requires a supported Java runtime. During installation, the script checks whether Java is installed and whether the version meets the requirement. Common errors:

  1. Java Version 21+ is required, but not found at: ...
    • Java is not installed. Install Java 21 or later.
    • Java is installed but not found. Create a symlink, for example: ln -s /path/to/your-java-executable /usr/local/bin/java.
  2. Java Version 21+ is required, but version X is found at: ...
    • The Java version is too low. Install Java 21 or later.
    • A qualifying Java is installed but not found first on PATH. Create a symlink as above, and ensure the correct Java executable has the highest priority on PATH. The error message prints the search path used by the installer.

14.3.2.3 Configure the TSDB connection​

TDengine IDMP requires TDengine TSDB-Enterprise 3.4.1.7 or later. Before starting IDMP, configure the TDengine TSDB-Enterprise connection. Open the IDMP configuration file with a text editor. The default location is:

  • Linux/macOS: /usr/local/taos/idmp/config/application.yml
  • Windows: C:\TDengine\idmp\config\application.yml

Under tda.default-connection, set the connection details:

tda:
  default-connection:
    enable: true
    auth-type: UserPassword # can be set to UserPassword or Token
    url: http://192.168.1.100:6041
    username: root
    password: taosdata
    explorer-url: http://192.168.1.100:6060

Where:

  • auth-type: Authentication method. Supports UserPassword (default) and Token.
  • url: The IP address and port of the taosAdapter component in TDengine TSDB-Enterprise. The default port is 6041.
  • username and password: Credentials for TDengine TSDB-Enterprise. Defaults are root and taosdata.
  • explorer-url: The taosExplorer URL. The default port is 6060. If you access IDMP remotely, set this to the server's actual IP address or domain name; otherwise the browser cannot reach Explorer.
Complete Configuration Reference
  • For the complete IDMP configuration file reference, see: TDengine IDMP Configuration File Reference

  • To configure the base path for the gateway reverse proxy, you first need to explicitly specify this base path by setting the TDA_REST_BASE_PATH environment variable. Meanwhile, the gateway side needs to complete two configurations: 1. Configure the routing forwarding rule pointing to http://<target address>/idmp_config; 2. Configure the path rewriting rule to ensure that the aforementioned base path contained in the request URL is removed before forwarding the request to the backend service.

After you finish this configuration, you can start the TDengine IDMP service.

14.3.2.4 Start TDengine IDMP​

Run the following command to start TDengine IDMP:

sudo svc-tdengine-idmp start

You can also use other svc-tdengine-idmp commands to check status or stop the service:

sudo svc-tdengine-idmp status # Check service status
sudo svc-tdengine-idmp stop   # Stop service

You can also manage services with systemctl. After installation, the service names are:

  • tdengine-idmp-h2
  • tdengine-idmp-backend
  • tdengine-idmp-ui
  • tdengine-idmp-chat
  • tdengine-idmp-cls

For example:

sudo systemctl start tdengine-idmp-h2
sudo systemctl start tdengine-idmp-backend
sudo systemctl start tdengine-idmp-ui
sudo systemctl start tdengine-idmp-chat

sudo systemctl status tdengine-idmp-backend
sudo systemctl stop tdengine-idmp-ui
sudo systemctl stop tdengine-idmp-backend
sudo systemctl stop tdengine-idmp-chat
sudo systemctl stop tdengine-idmp-h2
info

Root permissions are required to run these commands. On non-root accounts, prefix the command with sudo. You can also operate a single component, for example: sudo svc-tdengine-idmp start backend.

By default, the TDengine IDMP service listens on:

  • HTTP: http://localhost:6042 or http://ip:6042
  • HTTPS: https://localhost:6034 or https://ip:6034

14.3.2.5 Uninstall TDengine IDMP​

Uninstall TDengine IDMP:

rmidmp -e yes

To keep data, logs, and configuration:

rmidmp -e no

If installed with rpm (Linux):

rpm -e tdengine-idmp

If installed with deb (Linux):

dpkg -r tdengine-idmp

14.3.2.6 Upgrade TDengine IDMP​

Use the official install script to upgrade. The script detects an existing installation and enters upgrade mode so user data and configuration remain safe:

  • Automatic upgrade detection: The script determines whether the run is an upgrade.
  • Data and configuration protection: In upgrade mode, the script does not overwrite or modify these directories:
  • data/idmp: user data
  • idmp/venv: Python virtual environment
  • idmp/config: configuration
  • logs: logs
  • Program files only: The upgrade updates program files and dependencies while leaving user data and configuration unchanged.
  • Fresh install: On a first install, all directories and files are initialized.
info

Always upgrade with the official install script. If you need a manual backup, copy the directories above before upgrading. After the upgrade, check service status and logs to confirm success.