WebStorm 2022.3 Help

Docker connection settings

Specify the settings for accessing the Docker API. For more information about using the Docker integration with WebStorm, see Docker.

Enable the Docker plugin

This functionality relies on the Docker plugin, which is bundled and enabled in WebStorm by default. If the relevant features are not available, make sure that you did not disable the plugin.

  1. Press Ctrl+Alt+S to open the IDE settings and select Plugins.

  2. Open the Installed tab, find the Docker plugin, and select the checkbox next to the plugin name.

You can add multiple Docker configurations, each representing a connection to a separate Docker daemon:

the Add button Docker

Add a new Docker configuration.

the Remove button Delete Alt+Delete

Remove the selected Docker configuration.

For each Docker configuration, specify a name and choose the connection type depending on the operating system:

Docker for Windows

This is the recommended option when using Docker Desktop for Windows.

Docker for Mac

This is the recommended option when using Docker Desktop for macOS.

Unix socket

This is the recommended option when using Docker Desktop for Linux.

TCP socket

Configure the URL to the Docker Engine API manually.

In the Engine API URL field, you can specify a TCP connection to a remote Docker daemon or any Docker socket path, including a custom local socket. For example, in rootless mode, the Docker daemon runs via a systemd user service with a unique identifier, so the socket path will be something like unix:///run/user/1000/docker.sock.

By default, on macOS and Linux, the Docker daemon listens for Docker Engine API requests on the Unix socket at unix:///var/run/docker.sock.

If you are using Docker Desktop for Windows, you can connect to the Docker Engine through a named pipe at npipe:////./pipe/docker_engine or a TCP socket at tcp://localhost:2375.

You can also connect to Podman, which has an API that is equivalent to the Docker Engine API. .

SSH

Connect to a remote Docker daemon via an existing SSH configuration or create a new one.

WSL

Connect to a Docker daemon running in Windows Subsystem for Linux (WSL).

Minikube

If you are running minikube, select this option to automatically detect and connect to the minikube's Docker Engine environment.

If WebStorm cannot detect minikube or if it is running remotely, run the minikube docker-env command to get the necessary connection information and set the following under TCP socket:

  • Engine API URL: the value of DOCKER_HOST (with https as the protocol instead of tcp)

  • Certificates folder: the value of DOCKER_CERT_PATH

In the table below, specify the mappings for folders that the host and the container volumes can share:

the Add button Add Alt+Insert

Add a new mapping.

the Remove button Remove Ctrl+Y

Remove the selected mapping.

the Edit button Edit Enter

Edit the selected mapping.

Virtual machine path

The path to the directory in the Docker virtual machine's file system.

Local path

The path to the local folder that you want to bind to the corresponding directory in the virtual machine.

Last modified: 13 January 2023