Add Docker devices

Create Docker devices from Docker images and use them to build, run, and debug applications. A Docker container operates like a virtual machine but uses less system resources at the cost of being less flexible.

While Linux, macOS, and Windows hosts are supported in principle, Linux is the recommended platform.

To build, run, and debug applications on Docker devices, install and configure docker-cli on the development host. Qt Creator automatically detects build and run kit items, such debuggers and Qt versions, in the Docker container and creates kits for the devices.

You are advised to use CMake to build applications in the Docker container.

Note: Enable the Docker plugin to use it.

To pull images from Docker hub or other registries, use the docker pull command.

Add Docker images as devices

To add a Docker image as a device:

  1. Go to Preferences > Devices > Docker.
  2. In Command, enter the path to the Docker CLI.

    {Docker tab in Devices preferences}

  3. Go to Devices.
  4. Select Add > Docker Device > Start Wizard to search for images in your local Docker installation.
  5. Select a Docker image, and then select OK.
  6. In Devices, check and change Docker device preferences.

    {Docker device preferences}

  7. Select Apply to save your changes.

Select Docker images

The Docker Image Selection dialog displays a list of Docker images in your local Docker installation. You can sort the images according to the repository name or tag or the image ID or size.

{Docker Image Selection dialog}

Select Show unnamed images to show images that are not tagged.

Double-click an image to select it.

Edit Docker device kits

Go to Preferences > Kits to check that the automatically generated kits point to the appropriate kit items.

See also Enable and disable plugins, How To: Develop for Docker, and How To: Manage Kits.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.