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 Community Edition account that supports Edge functionality.

You can install a local ThingsBoard CE server. The local server is accessible at http://localhost:8080.

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. Sign in to your ThingsBoard instance and go to Edge Management → Instances. Click Add (+) in the top-right corner and select Add new edge.

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

   Click Add.
3. Your new Edge instance is created and appears at the top of the list.

Go to Edge Management → Instances and click Add (+) Enter the Edge name and click Add The new Edge instance appears at the top of the list

Once an Edge instance is created, the server generates pre-configured installation instructions containing the Edge credentials (Edge Key, Edge Secret, etc.). To access them:

1. Click the Edge entity to open its details.
2. Click Install & Connection Instructions.
3. Select the installation method and follow the instructions to install Edge and connect it to the server.

Click the Edge entity to open its details Click Install & Connection 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.

In the Edge instance details panel, click Copy Edge Key and Copy Edge Secret. 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.3.1.1"
    ports:
      - "8080:8080"
      - "1883:1883"
      - "5683-5688:5683-5688/udp"
    environment:
      SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/tb-edge
      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
    volumes:
      - mytb-edge-data:/data
      - mytb-edge-logs:/var/log/tb-edge
  postgres:
    restart: always
    image: "postgres:16"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: tb-edge
      POSTGRES_PASSWORD: postgres
    volumes:
      - mytb-edge-data-db:/var/lib/postgresql/data
volumes:
  mytb-edge-data:
    external: true
  mytb-edge-logs:
    external: true
  mytb-edge-data-db:
    external: true

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.

Log in using the same default credentials listed in the Prerequisites section. You can change them in the Edge UI after logging in.

To detach from the session terminal without stopping the container, press Ctrl+p then Ctrl+q.

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.