Install with Docker Compose (Linux / macOS)

Install and run ThingsBoard IoT Gateway using Docker Compose on Linux or macOS.

• Docker Compose is installed.
• A running ThingsBoard instance. Use ThingsBoard Cloud or install ThingsBoard locally — see the installation guide.

1. Create a Gateway device and download the docker-compose.yml file.

   In ThingsBoard, go to Entities > Gateways and click the + icon in the upper-right corner. Enter a name, select the default device profile, and click Create. In the Launch command window that opens, click Download to save the docker-compose.yml file.

   Go to Entities > Gateways and click the + icon to add a new gateway. Enter a gateway name, select the default device profile, and click Create. Click Download to save the docker-compose.yml file pre-configured for your gateway.

2. Start the Gateway. From the directory containing the downloaded docker-compose.yml file, run:

   docker compose up

   

To run the Gateway in detached (background) mode:

docker compose up -d

To view the Gateway logs after detaching:

docker logs -f tb-gateway

To update the Gateway to the latest image:

docker compose down
docker pull thingsboard/tb-gateway
docker compose up -d

For a full upgrade guide, see Upgrade instructions.