Run/Debug Configuration: Docker

Run | Edit Configurations | | Docker

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.

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

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, CLion 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 CLion stores run configuration settings in .idea/workspace.xml.

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, CLion 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 CLion stores run configuration settings in .idea/workspace.xml.

Docker Image run configuration settings

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

Item	Description
Image ID	Specify the ID of the image to run.
Container name	Specify an optional name for the container. If empty, Docker will generate a random name for the container.
Entrypoint	Override the default ENTRYPOINT set by the image. Similar to using the `--entrypoint` option with `docker run`.
Command	Override the default CMD set by the image. Similar to specifying the optional `COMMAND` argument after `docker run`.
Publish exposed ports to the host interfaces	Select 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 mounts	Specify the list of volume bindings. Similar to using the `-v` option with `docker run`.
Environment variables	Specify the list of environment variables. Similar to using the `-e` option with `docker run`.
Run options	Specify arbitrary options for the `docker run` command. Not all `docker run` options are supported. If you would like to request support for some option, leave a comment in IDEA-181088.
Command preview	Preview 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:

Item	Description
Compose file	Specify the Docker Compose files to use for this run configuration.

Dockerfile run configuration settings

The following settings are available for the Dockerfile run configuration:

Item	Description
Dockerfile	Specify the Dockerfile to be used for this run configuration.
Image tag	Specify the name and tag for the built image. Similar to using the `-t` option with `docker build`.
Build args	Override the default build-time variables. Similar to using the `--build-arg` option with `docker build`.
Run built image	Select to run a container based on the built image.
Container name	Specify an optional name for the container. If empty, Docker will generate a random name for the container.
Entrypoint	Override the default ENTRYPOINT set by the image. Similar to using the `--entrypoint` option with `docker run`.
Command	Override the default CMD set by the image. Similar to specifying the optional `COMMAND` argument after `docker run`.
Publish exposed ports to the host interfaces	Select All to expose all container ports to the host or select Specify to specify which container ports to bind.
Bind ports	Specify the list of port bindings. Similar to using the `-p` option with `docker run`.
Bind mounts	Specify the list of volume bindings. Similar to using the `-v` option with `docker run`.
Environment variables	Specify 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. Not all `docker run` options are supported. If you would like to request support for some option, leave a comment in IDEA-181088.
Command preview	Preview the resulting command that will be used to execute the run configuration.

Last modified: 16 July 2021