本页目录

• Prerequisites
  • ThingsBoard Cloud server
  • Edge provision on cloud
  • Docker installation
  • Edge hardware requirements
• Step 1. Running ThingsBoard Edge
• Step 2. Open ThingsBoard Edge UI
• Step 3. Detaching, stop and start commands
• Troubleshooting
  • DNS issues
• Next Steps

This guide will help you to install and start ThingsBoard Edge using Docker on Windows.

Prerequisites

ThingsBoard Cloud server

To start using ThingsBoard Edge you need to have ThingsBoard server that supports edge functionality up and running.

The easiest way is to use Live Demo server.
The alternative option is to install ThingsBoard Community Edition server that supports edge functionality on-premise. Please visit Install CE to install 3.3 version or higher of server that supports edge functionality.

Edge provision on cloud

Additionally, you will need to provision ThingsBoard Edge on cloud server. Please follow Step 1 first if you skipped it.

Once ThingsBoard Edge provisioned on cloud server please follow installation steps below.

Docker installation

• Install Docker Toolbox for Windows

Edge hardware requirements

Hardware requirements depend on an amount of devices connected to the edge and GUI usage locally.

To run ThingsBoard Edge without heavily usage of GUI (local dashboards, device management etc.) and relatively small amount of devices (under 100) on a single machine you will need at least 1GB of RAM.

To run ThingsBoard Edge with heavily usage of GUI (local dashboards, device management etc.) and with 100+ devices on a single machine we recommend having at least 4GB of RAM.

Step 1. Running ThingsBoard Edge

Here you can find ThingsBoard Edge docker image:

• thingsboard/tb-edge

Windows users should use docker managed volume for ThingsBoard Edge DataBase. Create docker volume (for ex. mytb-edge-data) before executing docker run command: Open “Docker Quickstart Terminal”. Execute the following command to create docker volume:

1
2
3
docker volume create mytb-edge-data
docker volume create mytb-edge-logs
docker volume create mytb-edge-data-db

Create docker compose file for ThingsBoard Edge service:

1
docker-compose.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
version: '3.0'
services:
  mytbedge:
    restart: always
    image: "thingsboard/tb-edge:3.5.1EDGE"
    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.250 or demo.thingsboard.io
    volumes:
      - mytb-edge-data:/data
      - mytb-edge-logs:/var/log/tb-edge
  postgres:
    restart: always
    image: "postgres:12"
    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

Where:

• restart: always - automatically start ThingsBoard Edge in case of system reboot and restart in case of failure;
• 8080:8080 - connect local port 8080 to exposed internal HTTP port 8080;
• 1883:1883 - connect local port 1883 to exposed internal MQTT port 1883;
• 5683-5688:5683-5688/udp - connect local UDP ports 5683-5688 to exposed internal COAP and LwM2M ports;
• mytb-edge-data:/data - mounts the host’s dir mytb-edge-data to ThingsBoard Edge DataBase data directory;
• mytb-edge-logs:/var/log/tb-edge - mounts the host’s dir mytb-edge-logs to ThingsBoard Edge logs directory;

• mytb-edge-data/db:/var/lib/postgresql/data - mounts the host’s dir mytb-edge-data/db to Postgres data directory;

• thingsboard/tb-edge:3.5.1EDGE - docker image;

• CLOUD_ROUTING_KEY - your edge key;
• CLOUD_ROUTING_SECRET - your edge secret;
• CLOUD_RPC_HOST - ip address of the machine with the ThingsBoard platform;

Please set CLOUD_RPC_HOST with an IP address of the machine where ThingsBoard version is running:

• DO NOT use ‘localhost’ - ‘localhost’ is the ip address of the edge service in the docker container.

• Use demo.thingsboard.io if you are connecting edge to ThingsBoard Live Demo for evaluation.

• Use X.X.X.X IP address in case edge is connecting to the cloud instance in the same network or in the docker.

If ThingsBoard Edge is going to be running on the same machine where ThingsBoard server is running you’ll need to update docker compose port mapping.

Please update next lines of docker compose:
…
ports:
- “18080:8080”
- “11883:1883”
- “15683-15688:5683-5688/udp”
…

Please make sure ports above are not used by any other application.

在包含该文件的目录终端中执行以下命令启动此docker compos：docker-compose.yml

1
2
3
docker compose pull
docker compose up -d
docker compose logs -f mytbedge

ThingsBoard3.4.2版本开始支持Docker Compose V2（Docker Desktop或Compose插件）因为Docker不再支持docker-compose作为独立设置。

我们强烈建议更新到Docker Compose V2 使用它。

更新最新镜像docker-compose命令：
docker-compose pull
docker-compose up -d
docker-compose logs -f mytbedge

In order to get access to necessary resources from external IP/Host on Windows machine, please execute the following commands:

1
2
3
4
set PATH=%PATH%;"C:\Program Files\Oracle\VirtualBox"
VBoxManage controlvm "default" natpf1 "tcp-port8080,tcp,,8080,,8080"  
VBoxManage controlvm "default" natpf1 "tcp-port1883,tcp,,1883,,1883"
VBoxManage controlvm "default" natpf1 "tcp-port5683,tcp,,5683,,5683"

Where:

• C:\Program Files\Oracle\VirtualBox - path to your VirtualBox installation directory

Step 2. Open ThingsBoard Edge UI

Once started, you will be able to open ThingsBoard Edge UI using the following link http://localhost:8080.

Use next Edge UI URL if during installation process you set HTTP_BIND_PORT to 18080:

http://localhost:18080

Please use your tenant credentials from local cloud instance or ThingsBoard Live Demo to log in to the ThingsBoard Edge.

Step 3. Detaching, stop and start commands

你可以使用Ctrl-p Ctrl-q与会话终端分离容器将继续在后台运行。

如果出现任何问题可以检查服务日志中的错误例如：要查看ThingsBoard容器日志。
请执行以下命令：

1
docker compose logs -f mytbedge

停止容器：

1
docker compose stop mytbedge

启动容器：

1
docker compose start mytbedge

Docker Compose已被弃用建议使用Docker Compose V2
更新最新镜像docker-compose命令：
docker-compose logs -f mytbedge
docker-compose stop mytbedge
docker-compose start mytbedge

Troubleshooting

DNS issues

注意：如果你发现与DNS问题相关的错误，例如

1
127.0.1.1:53: cannot unmarshal DNS message

你可以配置系统以使用Google公用DNS服务

Next Steps

Congratulations! You have successfully provisioned, installed and connected ThingsBoard Edge to ThingsBoard server.

You can continue with Getting started guide to get the basic knowledge of ThingsBoard Edge or you can jump directly to more advanced topics:

• Getting started guide - Provide quick overview of main ThingsBoard Edge features. Designed to be completed in 15-30 minutes:

• Edge Rule Engine:

  • Overview - Learn about ThingsBoard Edge Rule Engine.

  • Rule Chain Templates - Learn how to use ThingsBoard Edge Rule Chain Templates.

  • Provision Rule Chains from cloud to edge - Learn how to provision edge rule chains from cloud to edge.

  • Push data from edge to cloud and vice versa - Learn how to push data from edge to cloud and vice versa.

• Security:
  • gRPC over SSL/TLS - Learn how to configure gRPC over SSL/TLS for communication between edge and cloud.

• Features:

  • Edge Status - Learn about Edge Status page on ThingsBoard Edge.

  • Cloud Events - Learn about Cloud Events page on ThingsBoard Edge.

• Use cases:

  • Manage alarms and RPC requests on edge devices - This guide will show how to generate local alarms on the edge and send RPC requests to devices connected to edge:

  • Data filtering and traffic reduce - This guide will show how to send to cloud from edge only filterd amount of device data:

• Roadmap - ThingsBoard Edge roadmap.