Step 1: Create a Docker configuration On the main menu, choose File | Settings | Build, Execution, Deployment | Docker for Windows and Linux or JetBrains Rider | Preferences | Build, Execution, Deployment | Docker for macOS. On the Docker Settings page that opens, click in the central pane.
Step 2: Specify the Docker connection settings The connection settings depend on your Docker version and operating system. Option 1: Docker for macOS Connect to Docker daemon with: Docker for Mac Option 2: Docker for Windows
Connect to Docker daemon with: TCP socket
Engine API URL:tcp://localhost:2375
Certificates folder: Leave this field empty.
In the General section of your Docker settings, turn on the Expose daemon on tcp://localhost:2375 without TLS option.
Option 3: Docker for Linux Connect to Docker daemon with: Unix socket Option 4: Docker Toolbox for Windows or macOS Connect to Docker daemon with: Docker Machine
Step 3: Check your connection If the specified settings are correct, a Connection successful message is displayed. If no message appear, check your Docker Machine executable setting on the Docker | Tools page. For more information, see Docker connection settings.
Step 4 (optional): Map local folders to paths in the container If you are going to bind container volumes with local folders, on Windows and macOS you need to specify the corresponding mappings in the Path mappings section. For more information, see Working with volume bindings.
Step 5 (optional): Configure Docker Compose Open the Tools page (File | Settings | Build, Execution, Deployment | Docker | Tools for Windows and Linux or JetBrains Rider | Preferences | Build, Execution, Deployment | Docker | Tools for macOS) and specify the location of your Docker Compose executable. Accept the default setting docker-compose or click and choose your actual executable in the dialog box that opens.
How do I connect to Docker?
Open the Docker window by choosing View | Tool Windows | Docker.
Select a Docker node and click or choose Connect on the context menu.
How do I manage Docker images?
With JetBrains Rider, you can pull and push Docker images, add tags to them, detect IDs of images, as well as search images by parts of their names or ID. All these operations are performed from the dedicated Docker window.
To open the Docker tool window Choose View | Tool Windows | Docker on the main menu.
To pull an image In the Docker tool window, select a Docker node and click or choose Pull image on the context menu. In the dialog that opens, specify the following:
In the Registry field, type the URL of the image repository service (e.g. registry.hub.docker.com for Docker Hub) or a Docker Registry configuration.
In the Repository field, type the image name.
In the Tag field, set a tag to the image tag, e.g. latest.
To find out the ID of an image In the Docker tool window, select the image of interest. The image ID is shown on the Properties tab.
To hide images without tags In the Docker tool window, select the Images node or one of the images and click or choose Untagged images on the context menu.
To find a local image by its name or ID In the Docker tool window, switch to the left-hand pane and start type the name or ID of an image. JetBrains Rider highlights this text in the names and IDs of the images and containers wherever the text is detected.
To build an image
Create a Dockerfile for the image that you want to build and open the file in the editor.
To the left of FROM, click and choose Run on 'Docker'. Your image is built and run in a container according to your Dockerfile.
To delete a container after the corresponding image is built In the Docker tool window, select the container and click or choose Delete container on the context menu.
To push an image to an image repository
In the Docker tool window, select the image to upload and click or choose Push image on the context menu.
In the dialog that opens, specify the Docker Registry configuration to use, the name of the image you are pushing and the attached tag.
To delete one or several images In the Docker tool window, select the image or images to delete and click or choose Delete image on the context menu.
How do I specify my image repository user account information?
When you push an image to a repository you are required to log on to the corresponding server. Your image repository user account info that you have to provide in such cases is stored in what is called a Docker Registry configuration.
Step 1: Start creating a Docker Registry configuration
In the Docker tool window, select the image to upload and click or select a Docker node and click , depending on whether you are pushing or pulling an image.
In the Pull image or the Push image dialog that opens, click New.
Step 2: Specify the following Registry Configuration settings
In the Address field, type the image repository service URL, e.g. registry.hub.docker.com for Docker Hub or quay.io for Quay.
The user name and password for your user account.
The email address that you specified when creating your user account.
In the Server field, type the name of the associated Docker connection settings (usually, Docker). They are used to connect to the service to check that your user account info is correct.
How do I run images?
JetBrains Rider provides interface for running images from the Docker window or from a Dockerfile. In either case, JetBrains Rider automatically creates a dedicated Docker Deployment run/debug configuration with the default settings.
You can also view deployment logs and convert the command-line options for the docker run command into the container settings JSON file, this file can be used for configuring your container at its start.
Option 1: Run an image from the Docker tool window
In the Docker tool window, select the image to run and click or choose Create container on the context menu.
In the Create container popup, click Create.
In the Create Deployment Configuration dialog that opens specify the following:
In the Deployment field, the Docker Image option is selected. This indicates that the run configuration is based on an image available locally.
The Image ID field initially shows the ID of the image for which you called the Create container command.
In the Container name field, specify the name for the container that will be created. Otherwise, Docker will give your container a name automatically.
To the left of FROM, click and select Run on 'Docker'. Your image runs according to the Dockerfile and a Dockerfile-based run configuration is created.
The main settings of a run configuration associated with a Dockerfile are:
The Deployment field shows you Dockerfile.
The name and the tag of the image that will be built, e.g. myimage:latest.
The name of the container that will be created. If omitted, Docker will itself give your container a name.
Select the newly created configuration from the list on the toolbar and click .
To re-run a Dockerfile Click and choose Run '<ConfigurationName>' from the list.
To view deployment log After an image is built and corresponding container is started, select the container in the Docker tool window. The log is shown in the right-hand pane on the Deploy log tab.
To convert command-line options into container settings JSON
In the Docker tool window, right-click the container of interest and select Exec.
In the Run command in container popup, click Create.
In the dialog that opens, type the command and click OK. For docker exec [OPTIONS] CONTAINER COMMAND [ARG...] you need to specify only the COMMAND [ARG...] part. For example: ls /tmp or mkdir /tmp/my-new-dir.
In the Docker tool window, right-click the container and select Exec | Create.
Type: /bin/sh or /bin/bash
Press Enter or click OK.
Finding out the container and image IDs
In the Docker tool window, select the container of interest. Its ID and the ID of its parent image are shown on the Properties tab.
You can copy the image ID, and the container ID and name onto the clipboard: select the corresponding row in the table and click . As an alternative, you can use the Copy image ID and Copy container ID context menu commands.
Renaming a container
In the Docker tool window, select the container of interest.
Select the Properties tab.
In the Container name field, specify a new name for your container, and click Save.
Inspecting a container
You can get detailed low-level information about a container in JSON format by running docker inspect: In the Docker tool window, right-click the container of interest and select Inspect. The result is shown on the Inspection tab.
Showing container processes
To show the list of processes running in a container, right-click the container of interest in the Docker tool window and select Show processes. The result is shown on the Processes tab.
Opening a console for an ENTRYPOINT process
To see the output of the ENTRYPOINT process running inside a container, you can attach to its stdin/out: In the Docker tool window, right-click the container and select Attach. The console will open on the Attached console tab.
Viewing the container log
When you select a container in the Docker tool window, the container log is shown on the Log tab.
Stopping a container
In the Docker tool window, select the container, and then click or select Stop container from the context menu.
Restarting a container
In the Docker tool window, select the container, and then click or select Redeploy from the context menu.
Rerunning an image with different settings
In the Docker tool window, select the container in which the image of interest runs.
Click or select Edit Configuration from the context menu.
In the Docker tool window, you can hide the containers that are not running: Select the Containers node or one of the containers, and then click or select Stopped containers from the context menu.
Working with volume bindings
Preparing for volume bindings on Windows and macOS
To be able to map host folders to container volumes on Windows or macOS, you should first specify corresponding path mappings:
Open your Docker connection settings: in the Docker tool window, select the Docker node and click . Alternatively, Ctrl+Alt+S| Build, Execution, Deployment | Docker.
In the Path mappings section, select an existing mapping and click to edit it, or click to create a new mapping.
In the dialog that opens, specify the mapping:
Local path. The path to a local folder that you want to make available for volume bindings.
Virtual machine path. This is the corresponding directory path in the Docker virtual machine's file system.
Specifying the port binding settings in a run configuration
Create a new Docker Deployment run configuration or open an existing one.
Select the Container tab and expand the Volume bindings section.
To publish all the container ports, select the corresponding checkbox.
To specify individual bindings (the Publish all ports option in this case should be off), expand the Volume bindings section, and click to create a new binding.
In the dialog that opens, specify:
Container port. The container port to be mapped.
Protocol. TCP or UDP.
Host IP. To make the port accessible only from your localhost, specify localhost or 127.0.0.1. To make the port accessible from other computers on your network as well, specify 0.0.0.0.
Host port. The corresponding host port.
Viewing and editing the port binding settings for a running container
In the Docker tool window, select the container and then select the Port Bindings tab.
If the container was started with the Publish all ports option on, to see the port mappings, run the Inspect command from the container's context menu, and then search the result (Ctrl+F) for "Ports".
To create a new binding, click . To edit an existing one, select the binding and click . If the Publish all ports option is currently on, turn it off to be able to specify individual port mappings.
In a Docker Deployment run configuration, you can specify additional variables and redefine the ones that Docker sets. At a later time, when your container is running, you can view and edit the existing variables, and create and set new ones.
Specifying the environment variables in a run configuration
Create a new Docker Deployment run configuration or open an existing one.
Select the Container tab and expand the Environment variables section.
Click to create a new variable.
In the dialog that opens, specify the variable name and value.
Viewing and editing the environment variables for a running container
In the Docker tool window, select the container and then select the Environment variables tab.
To create a new variable, click . To edit an existing one, select the variable and click .
Open a Docker Deployment run configuration for a container that you want to link with another container.
Select the Container tab and expand the Links section.
Click to create a new link.
In the dialog that opens, specify:
Name. Select the container you want to link to.
Alias. The link name alias.
Start the container by executing the run configuration.
Now, to see the link information, select Inspect from the container's context menu in the Docker tool window. Then search the inspection result (shown on the Inspection tab, Ctrl+F) for HostConfig. The link information will be shown as "Links" : [ "<container_name>:<link_name_alias>" ].
Alternatively, you can open the Terminal tool window and run the following command: docker inspect -f "{{ .HostConfig.Links }}" <container_name>
Using Docker Compose
Running services via a Docker Deployment run configuration
Create a Docker Deployment run configuration: Run | Edit Configurations || Docker Deployment.
Next to Deployment, select your docker-compose.yml file.
Execute the run configuration: .
Scaling a service
In the Docker tool window, select the service you want to scale.
Click or select Scale from the context menu.
Specify how many containers you want in the service.
Stopping and starting a service
In the Docker tool window, select the service.
To stop the service, click or select Stop from the context menu.
To start the service, click or select Start from the context menu.
Interacting with containers
Most of the functions that JetBrains Rider provides for working with "independent" containers are also available for the containers within Docker Compose services. To access these functions, use the containers' context menus and the toolbar icons in the Docker tool window. For more info, see Working with containers.
If you are using Docker for Windows: In the General section of your Docker settings, the Expose daemon on tcp://localhost:2375 without TLS option is on.
When trying to pull an image, you may be getting the following message:
Failed to parse dockerCfgFile: <your_home_dir>/.docker/config.json, caused by: ... {"credsStore":"wincred"}
If this is the case, go to <your_home_dir>/.docker directory and delete the file config.json.
Unable to use Docker Compose
Make sure that the Docker Compose executable setting in your Docker settings is correct.
Unable to use port bindings
Make sure that the corresponding container ports are exposed. Use the EXPOSEDockerfile command.
My deployment log is empty
If you have another project open at the moment, you may find your deployment log in that project.
Limitations
Our Docker integration has limitations but we are working on its improvement. See the list of Docker issues in our tracking system and vote for the ones that you think should be resolved first of all.
in the central pane. 
and choose your actual executable in the dialog box that opens. 
and click 
or choose Connect on the context menu. 
or choose Pull image on the context menu. 
or choose Untagged images on the context menu. 
and choose Run on 'Docker'. 
or choose Delete container on the context menu. 
or choose Push image on the context menu. 
or choose Delete image on the context menu. 
or choose Create container on the context menu. 
. As an alternative, you can use the Copy image ID and Copy container ID context menu commands.
or select Stop container from the context menu.
or select Redeploy from the context menu.
or select Edit Configuration from the context menu.
or select Stopped containers from the context menu. 
to edit it, or click 
or select Scale from the context menu. 
