Docker
Docker enables developers to deploy applications inside containers for testing code in an environment identical to production.
WebStorm lets you manage Docker images, run containers, and use Docker Compose in the Services tool window (). As with other tool windows, you can start typing the name of an image or container to highlight the matching items.
Before you start
Make sure the Docker plugin is enabled on the Settings/Preferences | Plugins page, tab Installed, see Managing plugins for details.
Enable Docker support
Install and run Docker.
For more information, see the Docker documentation.
Configure the Docker daemon connection settings:
In the Settings/Preferences dialog Ctrl+Alt+S, select .
Click
to add a Docker configuration and specify how to connect to the Docker daemon.The connection settings depend on your Docker version and operating system. For more information, see Docker configuration.
The Connection successful message should appear at the bottom of the dialog.
If no message appears, check the Docker Machine executable setting on the Docker | Tools page.
Connect to the Docker daemon.
The configured Docker connection should appear in the Services tool window ( or Alt+8). Select the Docker node
, and click 
, or select Connect from the context menu.
To edit the Docker connection settings, select the Docker node and click
on the toolbar, or select Edit Configuration from the context menu.
Managing images
Docker images are executable packages for running containers. Depending on your development needs, you can use Docker for the following:
- Pull pre-built images from a Docker registry
For example, you can pull an image that runs a Node.js container to test how your application will interact with your production environment.
- Build images locally from a Dockerfile
For example, you can build an image that runs a container with some specific version of Node.js to execute your application inside it.
- Push your images to a Docker registry
For example, if you want to demonstrate to someone how your application runs in some specific version of Node.js instead of setting up the proper environment, they can run a container from your image.
Images are distributed via the Docker registry. Docker Hub is the default public registry with all of the most common images: various Linux flavors, database management systems, web servers, runtime environments, and so on. If you are going to work only with Docker Hub, no further registry configuration is required. To use another public and private Docker registry or deploy your own registry server, configure it in WebStorm first.
Configure a Docker registry
Press Ctrl+Alt+S to open IDE settings and select Build, Execution, Deployment | Docker | Registry.
Click
to add a Docker registry configuration and specify how to connect to the registry. If you specify the credentials, WebStorm will automatically check the connection to the registry. The Connection successful message should appear at the bottom of the dialog.The recommended registry for Node.js images is the Docker Official Images repository
Pull an image from a Docker registry
In the Services tool window, select the Images node.
Select the Docker registry and specify the repository and tag (name and version of the image, for example,
node:latest).
Press Ctrl+Enter to run docker pull.
Build an image from a Dockerfile
When you are editing a Dockerfile, WebStorm provides completion for images from the configured registries. You can also hold down Ctrl and click an image name to open its page in a web browser.
Open the Dockerfile from which you want to build the image.
Click
in the gutter and select to build the image.
WebStorm runs the docker build command.
Push an image to a Docker registry
In the Services tool window, select the image that you want to upload and click
or select Push Image from the context menu.
Select the Docker registry and specify the repository and tag (name and version of the image, for example,
my-app:v2).
Click OK to run the docker push command.
Images that you pull or build are stored locally and are listed in the Services tool window under Images. When you select an image, you can view its ID or copy it to the clipboard by clicking the 
button on the Properties tab.
To display detailed information about an image, right-click it and select Inspect from the context menu. WebStorm runs the docker image inspect command and prints the output to the Inspection tab.
Images with no tags <none>:<none> can be one of the following:
Intermediate images that serve as layers for other images and do not take up any space
Dangling images that remain when you rebuild an image based on a newer version of another image. You should regularly prune dangling images to preserve disk space.
To hide untagged images from the list, click 
on the Docker toolbar, and then click Untagged Images to remove the check mark.
To delete one or several images, select them in the list and click 
.
Running containers
Containers are runtime instances of corresponding images. For more information, see the docker run command reference.
WebStorm uses run configurations () to run Docker containers. There are three types of Docker run configurations:
Docker Image: Created automatically when you run a container from an existing image. You can run it from a locally existing Docker image that you either pulled or built previously.
Dockerfile: Created automatically when you run a container from a Dockerfile. This configuration builds an image from the Dockerfile, and then derives a container from this image.
Run a container from an existing image
In the Services tool window, select an image and click
or select Create Container from the context menu.
In the Create container popup, click Create.
In the Create Docker Configuration dialog that opens, you can provide a unique name for the configuration and specify a name for the container. If you leave the Container name field empty, Docker will give it a random unique name.
When you are done, click Run to launch the new configuration.
Run a container from a Dockerfile
Open the Dockerfile from which you want to run the container.
Click
in the gutter and select to run the container on a specific Docker node.
This creates and starts a run configuration with default settings, which builds an image based on the Dockerfile and then runs a container based on this image.
To create a run configuration with custom settings, click in the gutter and select New Run Configuration. You can specify a custom tag for the built image, as well as a name for the container, and a context folder from which to read the Dockerfile. The context folder can be useful, for example, if you have some artifacts outside of the scope of your Dockerfile, which you would like to add to the file system of the image.
Command-line options
Use the following syntax to start a container from the command line:
All optional parameters can be specified in the corresponding Docker run configuration fields.
Open the Docker run configuration
Do one of the following:
Select the container and click
on the toolbar.
In the Dockerfile, click
in the gutter and select Edit <configuration> from the list.
Select from the main menu.
Options are specified in the Run options field. In the previous screenshot, the container is connected to the my-net network and is assigned an alias my-app.
Commands and arguments to be executed when starting the container are specified in the Entrypoint and Command fields. These fields override the corresponding ENTRYPOINT and CMD instructions in the Dockerfile.
The Command preview field shows the actual Docker command used for this run configuration.
You can also configure the following container settings in the run configuration:
Bind mounts
Docker can mount a file or directory from the host machine to the container using the -v or --volume option. You can configure this in the Docker run configuration using the Bind mounts field.
Click 
in the Bind mounts field and add bindings by specifying the host directory and the corresponding path in the container where it should be mounted. Select Read only if you want to disable writing to the container volume.
For example, you can bind a local folder (path /Users/jetbrains/WS/node_docker/web) to the application folder inside the container (path usr/src/app) as shown on the screenshot above.
If you expand the Command preview field, you will see that the following line was added:
This can be used in the Run options field instead of creating the list of volume bindings using the Bind Mounts dialog.
View and modify volume bindings for a running container
In the Services tool window, select the container and then select the Volume Bindings tab.
To create a new binding, click
. To edit an existing one, select the binding and click .Specify the settings as necessary and click Save to apply the changes.
The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.
Bind ports
Docker can map specific ports on the host machine to ports in the container using the -p or --publish option. This can be used to make the container externally accessible. In the Docker run configuration, you can choose to expose all container ports to the host or use the Bind ports field to specify port mapping.
Click in the Bind ports field and bindings by specifying which ports on the host should be mapped to which ports in the container. You can also provide a specific host IP from which the port should be accessible (for example, you can set it to 127.0.0.1 to make it accessible only locally, or set it to 0.0.0.0 to open it for all computers in your network).
If you already have Node.js running on the Docker host port %5432%, you can map port %5433% on the host to %5432% inside the container as illustrated on the screenshot above. This will make Node.js running inside the container accessible via port %5433% on the host.
If you expand the Command preview field, you will see that the following line was added:
This can be used in the Run options field instead of creating the list of port bindings using the Port Bindings dialog.
View and modify port bindings for a running container
In the Services tool window, select the container and then select the Port Bindings tab.
To create a new binding, click
. To edit an existing one, select the binding and click . If the Publish all ports checkbox is selected, clear it to be able to specify individual port mappings.Specify the settings as necessary and click Save to apply changes.
The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.
Environment variables
Environment variables are usually set in the Dockerfile associated with the base image that you are using. There are also environment variables that Docker sets automatically for each new container. You can specify additional variables and redefine the ones that Docker sets using the -e or --env option. In a Docker run configuration, you can use the Environment variables field to configure environment variables.
Click in the Environment variables field to add names and values for variables. For example, if you want to suppress colors in REPL, set the NODE_DISABLE_COLORS = 1 as shown on the screenshot above.
If you expand the Command preview field, you will see that the following line was added:
This can be used in the Run options field instead of creating the list of names and values using the Environment Variables dialog. If you need to pass sensitive information (passwords, secrets, and so on) as environment variables, you can use the --env-file option to specify a file with this information.
View and modify environment variables for a running container
In the Services tool window, select the container and then select the Environment variables tab.
To add a new variable, click
. To edit an existing one, select the variable and click .Specify the settings as necessary and click Save to apply changes.
The container is stopped and removed, and a new container is created with the specified changes. However, changes are not saved in the corresponding run configuration.
Build-time arguments
Docker can define build-time values for certain environment variables that do not persist in the intermediate or final images using the --build-arg option for docker build. These must be specified in the ARG instruction of the Dockerfile with a default value. You can configure build-time arguments in the Docker run configuration using the Build args field.
For example, you can use build-time arguments to build the image with a specific version of Node.js. To do this, add the ARG instruction to the beginning of your Dockerfile:
The WSNODETAG variable in this case will default to latest if you do not redefine it as a build-time argument. So by default, this Dockerfile will produce an image with the latest available Node.js version. However, you can use the Build Args field to redefine the WSNODETAG variable.
In the screenshot above, WSNODETAG is set to 8, which will instruct Docker to pull node:8. When you deploy this run configuration, it will build an image and run the container with Node.js version 8.
To check this, execute node --version inside the container and see the output: it should be v8.12.0 or some later version.
If you expand the Command preview field, you will see that the following option was added to the docker build command:
Interacting with containers
Created containers are listed in the Services tool window. When you select a container, you can view its ID (and the ID of the corresponding image) and copy it to the clipboard using on the Properties tab. You can also specify a new name for the container and click Save to start another container with this new name from the same image.
By default, the Services tool window displays all containers, including those that are not running. To hide stopped containers from the list, click , and then click Show Stopped Containers to remove the checkbox.
If a container was created using a Docker run configuration, to view its deployment log, select it and open the Deploy log tab. To view the log messages from the container's STDOUT and STDERR, select it and open the Log tab. For more information, see the docker logs command reference.
You can browse the files inside a running container using the Files tab. Select any file and click 
to open it remotely in the editor or click 
to create a copy of the file as a scratch.
Execute a command inside a running container
In the Services tool window, right-click the container name and then click Exec.
In the Run command in container popup, click Create.
In the Exec dialog, type the command and click OK. For example:
ls /tmpList the contents of the /tmp directory
mkdir /tmp/my-new-dirCreate the my-new-dir directory inside the /tmp directory
/bin/bashStart a bashsession
For more information, see the docker exec command reference.
View detailed information about a running container
In the Services tool window, right-click the container name and then click Inspect.
The output is rendered as a JSON array on the Inspection tab.
For more information, see the docker inspect command reference.
View processes running in a container
In the Services tool window, right-click the container name and then click Show processes.
The output is rendered as a JSON array on the Processes tab.
For more information, see the docker top command reference.
Attach a console to the output of an executable container
In the Services tool window, right-click the container and then click Attach.
The console is attached to the output of the ENTRYPOINT process running inside a container, and is rendered on the Attached console tab.
For more information, see the docker attach command reference.
Docker Compose
Docker Compose is used to run multi-container applications. For example, you can run a web server, backend database, and your application code as separate services. Each service can be scaled by adding more containers if necessary. This enables you to perform efficient development and testing in a dynamic environment, similar to production.
Run a multi-container Docker application
Define necessary services in one or several Docker Compose files.
From the main menu, select .
Click
, point to Docker and then click Docker-compose. 
Specify the Docker Compose files that define services which you want to run in containers. If necessary, you can restrict the services that this configuration will start, specify environment variables, and force building of images before starting corresponding containers (that is, add the
--buildoption for the docker-compose up command).When the run configuration is ready, execute it.
When Docker Compose runs your multi-container application, you can use the Services tool window to control specific services and interact with containers. The containers are listed under the dedicated Compose nodes, not under the Containers node (which is only for standalone containers).
Scale a service
In the Services tool window, select the service you want to scale and click
or select Scale from the context menu. 
Specify how many containers you want for this service and click OK.
Stop a running service
In the Services tool window, select the service and click
or select Stop from the context menu. 
Stop all running services
In the Services tool window, select the Compose node and click
. 
Bring your application down
In the Services tool window, select the Compose node and click
. 
This stops and removes containers along with all related networks, volumes, and images.
Open the Docker Compose file that was used to run the application
In the Services tool window, right-click the Compose node or a nested service node and then click Jump to Source in the context menu F4.
The Docker-compose run configuration will identify environment files with the .env suffix if they are located in the same directory as the Docker Compose file.
Troubleshooting
If you encounter one of the following problems, try the corresponding suggested solution.
Unable to connect to Docker
Make sure that:
Docker is running.
Your Docker connection settings are correct.
If you are using Docker for Windows, enable the Expose daemon on tcp://localhost:2375 without TLS option in the General section of your Docker settings.
If you are using Docker Toolbox, make sure that Docker Machine is running and its executable is specified correctly in the Settings/Preferences dialog Ctrl+Alt+S under Build, Execution, Deployment | Docker | Tools.
Unable to use Docker Compose
Make sure that the Docker Compose executable is specified correctly in the Settings/Preferences dialog Ctrl+Alt+S under Build, Execution, Deployment | Docker | Tools.
Unable to use port bindings
Make sure that the corresponding container ports are exposed. Use the EXPOSE command in your Dockerfile.
Unable to associate existing Dockerfiles or Docker Compose files with relevant types
When you create new Dockerfiles or Docker compose files, WebStorm automatically identifies their type. If a file type is not evident from its name, you will be prompted to select the file type manually. To associate an existing file with the correct type, right-click it in the Project view and select Associate with File Type from the context menu.
If the Associate with File Type actions is disabled, this probably means that the filename is registered as a pattern for current file type. For example, if you have a Dockerfile with a custom name that is recognized as a text file, you cannot associate it with the Dockerfile type. To remove the file type pattern, do the following:
Press Ctrl+Alt+S to open IDE settings and select Editor | File Types.
Select the relevant file type (in this case: Text) and remove the pattern with the name of the file.
Click OK to apply the changes.
Now you should be able to set the correct file type using Associate with File Type in the context menu.
Limitations
The Docker integration plugin has certain limitations and bugs, however JetBrains is constantly working on fixes and improvements for it. You can find the list of Docker issues in our bug tracking system and vote for the ones that affect you the most. You can also file your own bugs and feature requests.