WebStorm 2021.1 Help

Run/Debug Configuration: Docker

Run | Edit Configurations | Add New Configuration | Docker

This page describes the configuration-specific items as well as options that are common for all run/debug configurations. To learn how to use this configuration, see Running containers, Running a container from a Dockerfile, and Docker Compose.

Docker run configurations enable you to integrate Docker into your development process. Settings depend on the type of the Docker run configuration relevant to your needs. Some settings are common, while others are specific in each case.

WebStorm provides Docker support using the Docker plugin. The plugin is bundled and enabled by default. For more information, see Docker.

Docker Image run configuration settings

The following settings are available for the Docker Image run configuration:

ItemDescription
Image IDSpecify the ID of the image to run.
Container nameSpecify an optional name for the container. If empty, Docker will generate a random name for the container.
EntrypointOverride the default ENTRYPOINT set by the image. Similar to using the --entrypoint option with docker run.
CommandOverride the default CMD set by the image. Similar to specifying the optional COMMAND argument after docker run.
Publish exposed ports to the host interfacesSelect All to expose all container ports to the host or select Specify to define specific container ports to bind.
Bind ports Specify the list of port bindings. Similar to using the -p option with docker run.
Bind mountsSpecify the list of volume bindings. Similar to using the -v option with docker run.
Environment variablesSpecify the list of environment variables. Similar to using the -e option with docker run.
Run options

Specify arbitrary options for the docker run command.

Command previewPreview the resulting command that will be used to execute the run configuration.

Docker-compose run configuration settings

The following settings are available for the Docker-compose run configuration:

ItemDescription
Compose fileSpecify the Docker Compose files to use for this run configuration.
Service(s)

In this field, specify one or more services to run. Use Shift + Arrow Keys to scroll through the list of services defined in the selected Docker Compose files. To add a service to the run configuration, press Enter.

Dockerfile run configuration settings

The following settings are available for the Dockerfile run configuration:

ItemDescription
DockerfileSpecify the Dockerfile to be used for this run configuration.
Image tagSpecify the name and tag for the built image. Similar to using the -t option with docker build.
Build argsOverride the default build-time variables. Similar to using the --build-arg option with docker build.
Run built imageSelect to run a container based on the built image.
Container nameSpecify an optional name for the container. If empty, Docker will generate a random name for the container.
EntrypointOverride the default ENTRYPOINT set by the image. Similar to using the --entrypoint option with docker run.
CommandOverride the default CMD set by the image. Similar to specifying the optional COMMAND argument after docker run.
Publish exposed ports to the host interfacesSelect All to expose all container ports to the host or select Specify to specify which container ports to bind.
Bind portsSpecify the list of port bindings. Similar to using the -p option with docker run.
Bind mountsSpecify the list of volume bindings. Similar to using the -v option with docker run.
Environment variablesSpecify the list of environment variables. Similar to using the -e option with docker run.
Command line options

Specify arbitrary options for the docker run command.

Command previewPreview the resulting command that will be used to execute the run configuration.

Common

When you edit a run configuration (but not a run configuration template), you can specify the following options:

Item

Description

Name

Specify a name for the run/debug configuration to quickly identify it when editing or running the configuration, for example, from the Run popup Alt+Shift+F10.

Allow parallel run

Select to allow running multiple instances of this run configuration in parallel.

By default, it is disabled, and when you start this configuration while another instance is still running, WebStorm suggests to stop the running instance and start another one. This is helpful when a run/debug configuration consumes a lot of resources and there is no good reason to run multiple instances.

Store as project file

Save the file with the run configuration settings to share it with other team members. The default location is .idea/runConfigurations. However, if you do not want to share the .idea directory, you can save the configuration to any other directory within the project.

By default, it is disabled, and WebStorm stores run configuration settings in .idea/workspace.xml.

Toolbar

The tree view of run/debug configurations has a toolbar that helps you manage configurations available in your project as well as adjust default configurations templates.

ItemShortcutDescription
the Add buttonAlt+InsertCreate a run/debug configuration.
the Remove buttonAlt+DeleteDelete the selected run/debug configuration. Note that you cannot delete default configurations.
CopyCtrl+DCreate a copy of the selected run/debug configuration. Note that you create copies of default configurations.
Save configurationThe button is displayed only when you select a temporary configuration. Click this button to save a temporary configuration as permanent.
Move into new folder / Create new folder

Move into new folder / Create new folder. You can group run/debug configurations by placing them into folders.

To create a folder, select the configurations within a category, click Folder, and specify the folder name. If only a category is in focus, an empty folder is created.

Then, to move a configuration into a folder, between the folders or out of a folder, use drag or Move Up and Move Down buttons.

To remove grouping, select a folder and click Remove Configuration.

Sort configurations Click this button to sort configurations in the alphabetical order.

Before Launch

In this area, you can specify tasks to be performed before starting the selected run/debug configuration. The tasks are performed in the order they appear in the list.

ItemShortcutDescription
the Add buttonAlt+Insert

Click this icon to add one of the following available tasks:

  • Run External tool: select to run an external application. In the dialog that opens, select one or multiple applications you want to run. If it is not defined in WebStorm yet, add its definition. For more information, see External tools and External Tools.

  • Run Another Configuration: select to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.

  • Run File Watchers: select this option to have WebStorm apply all the currently active File Watchers.

  • Run Grunt task: select this option to run a Grunt task.

    In the Grunt task dialog that opens, specify the Gruntfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Grunt tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the grunt-cli package.

  • Run Gulp task: select this option to run a Gulp task.

    In the Gulp task dialog that opens, specify the Gulpfile.js where the required task is defined, select the task to execute, and specify the arguments to pass to the Gulp tool.

    Specify the location of the Node.js interpreter, the parameters to pass to it, and the path to the gulp package.

  • Run npm Script: select this option to execute an npm script.

    In the NPM Script dialog that opens, specify the npm run/debug configuration settings.
  • Start React Native Bundler: select this option to run the bundler automatically, as part of a running or debugging session. by default, this is done through react-native start. If your application uses Expo, you need to run the development server via the start npm task. To do that, click Add, then in the Configure React Native dialog, choose npm script and select start from the list.

  • Compile TypeScript: select to run the built-in TypeScript compiler and thus make sure that all the changes you made to your TypeScript code are reflected in the generated JavaScript files. In the TypeScript Compile Settings dialog that opens, select or clear the Check errors checkbox to configure the behaviour of the compiler in case any errors are detected:

    • If the Check errors checkbox is selected, the compiler will show all the errors and the run configuration will not start.

    • If the Check errors checkbox is cleared, the compiler will show all the detected errors but the run configuration still will be launched.

  • Generate CoffeeScript Source Maps: select this option to generate the source maps for your CoffeeScript sources. In the dialog that opens, specify where your CoffeeScript source files are located.

  • Upload files to Remote Host: select this option to have the application files automatically uploaded to the server according to the default server access configuration.

the Remove buttonAlt+DeleteClick this icon to remove the selected task from the list.
EditEnterClick this icon to edit the selected task. Make the necessary changes in the dialog that opens.
Method up/ Method downAlt+Up/ Alt+DownClick these icons to move the selected task one line up or down in the list. The tasks are performed in the order that they appear in the list.
Show this pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

By default this checkbox is selected and the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, if the checkbox is cleared, the tool window is hidden. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing Alt+4 or Alt+5.

Last modified: 16 July 2021