Installing ThingsBoard Edge using Docker (Windows)

This guide provides step-by-step instructions for running ThingsBoard Edge on Windows using Docker.

To run ThingsBoard Edge, you need an active ThingsBoard account that supports Edge functionality.

You can use ThingsBoard Cloud or install a local ThingsBoard server.

The hardware requirements for ThingsBoard Edge depend on the number of connected devices and platform interaction intensity.

Install Docker Desktop for Windows before continuing.

To create a new Edge instance on your ThingsBoard Server:

1. Log in to your ThingsBoard server and go to Edge management > Edges. Click Add edge and select Add new edge.

2. Enter a name for the Edge, like My New Edge.

   If needed, update the Cloud endpoint (the field is shown only for Edges with legacy v1 licensing). If Edge runs in a Docker container, do not use localhost — use the IP address of the machine where ThingsBoard is hosted (e.g., http://10.7.2.143:8080). If you use ThingsBoard Cloud, keep the default. Click Add.
3. Your new Edge instance appears at the top of the list, and the Edge created dialog opens with ready-to-use installation instructions (unless Do not show again was turned on earlier).

Go to Edge management > Edges, click Add edge and select Add new edge Enter the Edge name and click Add The new Edge instance appears at the top of the list

The instructions generated by the server already contain the credentials of this Edge (Edge key and Edge secret), so this is the fastest way to install it. If you closed the dialog, open the instructions again:

1. Click the Edge to open its details.
2. On the Details tab, click Install & Connect Instructions.
3. Select the Docker, Ubuntu, or CentOS/RHEL tab and follow the instructions to install Edge and connect it to the server. The dialog opens on the Agent tab, which is for remote installation with a Remote Agent.

Click the Edge to open its details Click Install & Connect Instructions Follow the instructions to install and connect Edge to the server

If you are unable to use the guided instructions above, follow the steps below to install and configure Edge manually.

On the server, open the Edge and click Copy Edge key and Copy Edge secret on its Details tab. Store these values securely. You need them in the next step.

On Windows, ThingsBoard Edge requires pre-created named Docker volumes. Open PowerShell or Command Prompt and run:

docker volume create mytb-edge-data
docker volume create mytb-edge-logs
docker volume create mytb-edge-data-db

Create a docker-compose.yml file and add the following content:

services:
  mytbedge:
    restart: always
    image: "thingsboard/tb-edge:4.4.0.2EDGE"
    ports:
      - "8080:8080"
      - "1883:1883"
      - "5683-5688:5683-5688/udp"
    environment:
      SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/tb-edge
      EDGE_LICENSE_INSTANCE_DATA_FILE: /data/instance-edge-license.data
      CLOUD_ROUTING_KEY: PUT_YOUR_EDGE_KEY_HERE # e.g. 19ea7ee8-5e6d-e642-4f32-05440a529015
      CLOUD_ROUTING_SECRET: PUT_YOUR_EDGE_SECRET_HERE # e.g. bztvkvfqsye7omv9uxlp
      CLOUD_RPC_HOST: PUT_YOUR_CLOUD_IP # e.g. 192.168.1.1 or thingsboard.cloud
      CLOUD_RPC_SSL_ENABLED: 'false' # set it to 'true' if you are connecting edge to thingsboard.cloud
    volumes:
      - mytb-edge-data:/data
      - mytb-edge-logs:/var/log/tb-edge
  postgres:
    restart: always

Configuration parameters:

In the directory containing the docker-compose.yml file, run:

docker compose up -d
docker compose logs -f mytbedge

Once the service is running, open the Edge UI at http://localhost:8080 (or http://localhost:18080 if you changed the ports).

Log in using your tenant credentials from ThingsBoard Server or ThingsBoard Cloud. To check the connection, go to Edge > Status in the Edge UI. The status is Connected.

Press Ctrl+C to stop following the logs. The container keeps running.

To view ThingsBoard Edge logs:

docker compose logs -f mytbedge

To stop the container:

docker compose stop mytbedge

To start the container:

docker compose start mytbedge

To stop and remove all containers and networks:

docker compose down

To recreate and start all containers:

docker compose up -d

If you observe errors related to DNS resolution, for example:

127.0.1.1:53: cannot unmarshal DNS message

Configure your system to use Google Public DNS. For details, see the Windows instructions.