Docker connection settings
Last modified: 13 January 2023File | Settings | Build, Execution & Deployment | Docker for Windows and Linux
PyCharm | Settings | Build, Execution & Deployment | Docker for macOS
Ctrl+Alt+S
Specify the settings for accessing the Docker API. For more information about using the Docker integration with PyCharm, see Docker.
Enable the Docker plugin
This functionality relies on the Docker plugin, which is bundled and enabled in PyCharm by default. If the relevant features are not available, make sure that you did not disable the plugin.
note
The Docker plugin is available by default only in PyCharm Professional. For PyCharm Community Edition, you need to install the Docker plugin as described in Install plugins.
Press Ctrl+Alt+S to open the IDE settings and select Plugins.
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:
- Docker
Add a new Docker configuration.
- 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 likeunix:///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 attcp://localhost:2375
.You can also connect to Podman, which has an API that is equivalent to the Docker Engine API. For more information, see Podman.
note
Since the Certificates folder field specifies any folder with certificates, this field corresponds to the
DOCKER_CERT_PATH
environment variable. For more information, see Client modes in the Docker documentation.- SSH
Connect to a remote Docker daemon via an existing SSH configuration or create a new one.
- Minikube
If you are running minikube, select this option to automatically detect and connect to the minikube's Docker Engine environment.
If PyCharm 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
(withhttps
as the protocol instead oftcp
)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:
- Add Alt+Insert
Add a new mapping.
- Remove Ctrl+Y
Remove the selected mapping.
- 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.