Run/Debug Configuration: Docker Deployment
Docker Deployment run/debug configurations let you download and build Docker images, and create and start Docker containers. (The Docker integration plugin must be enabled.)
See also, Docker.
Name, Share and Single instance only
|Name||The name of the run configuration.|
Select this check box to share the run configuration through version control.
If the check box is not selected, the run configuration settings are stored in
If the check box is selected, the settings are stored in a separate
|Single instance only||If you select this check box, only one instance of the run configuration will run at a time.|
|Server||Select the Docker configuration to be used.
To create a new configuration, or to edit an existing one, click (Shift+Enter). For more information, see Docker.
|Deployment||One of the following:
The following settings are not available if a |
|Image ID||If Docker Image is selected in the Deployment field: the ID of the image to be deployed, a sequence of hexadecimal symbols. For the image of interest, you can, for example, use the Copy image ID command in the Application Servers tool window and then paste the ID into this field.|
|Image tag||If <docker-dir>/Dockerfile is selected
in the Deployment field:
if you want to use an image with a particular tag, specify that tag.
(The image in this case is specified in the Dockerfile.)
If nothing is specified,
Docker will look for the image with the tag |
|Container name||If you want to give the container that will be created a particular name, specify that name. Otherwise, Docker will itself decide what the name should be.|
|After launch||Select this check box to start a web browser after
starting the run/debug configuration.
Select the browser from the list. Click (Shift+Enter) to configure your web browsers.
|The field underneath After launch||Specify the URL the browser should go to when started. In most typical cases, this URL corresponds to the root of your Web application or its starting page.|
|Debug Port||The port to be used for debugging.
(Debugging is supported only for Java.)
This may be any unused port on your computer.
If there is a warning Debug port forwarding not found, click Fix. As a result, the necessary port mapping info is added to the JSON container settings file.
Note the command line arguments suggested by PyCharm. To make debugging possible, these should be used to start the JVM in the container.
This tab contains the settings for your container.
The settings on this tab are ignored if a
docker-compose.yml file is selected
in the Deployment field.
|JSON file||Path to a JSON file with container settings in the
Docker Remote API format.
CLI lets you translate
|The settings below the JSON file field take precedence when overlapping ones set in the JSON file.|
|Entrypoint||The entry point for your container, see e.g. ENTRYPOINT (default command to execute at runtime) in Docker run reference.|
|Command||See CMD (default command or options) in Docker run reference.|
|Publish all ports||
If the check box is selected, all the container’s exposed ports
are bound to a random host port. |
See e.g. EXPOSE (incoming ports) in Docker run reference.
Container port/protocol - Host IP address/port mappings.
For more info, see e.g. Connect using network port mapping in Linking containers together.
|Links||Container name - alias mappings. See e.g. Communication across links in Linking containers together.|
|Volume bindings||Volume bindings such as container path - host path. See e.g. Managing data in containers.|
|Environment variables||Environment variables as variable - value pairs. See e.g. ENV (environment variables) in Docker run reference.|
Before Launch options
Specify which tasks should be carried out before starting the run/debug configuration.
Click this icon to add a task to the list. Select the task to be added:
|Alt+Delete||Click this icon to remove the selected task from the list.|
|Enter||Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.|
|Alt+Up/Alt+Down||Click 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 page||Select this check box to show the run/debug configuration settings prior to actually starting the run/debug configuration.|
|Activate tool window||
If this check box is selected,
the Debug tool window opens
when you start the run/debug configuration in the debug mode.
Otherwise, the tool window isn't shown. However, when the configuration is running in the debug mode, you can open the Debug tool window for it yourself if necessary.
|Alt+Insert||Create a run/debug configuration.|
|Alt+Delete||Delete the selected run/debug configuration.|
|Ctrl+D||Create a copy of the selected run/debug configuration.|
|View and edit the default settings for the selected run/debug configuration.|
|Alt+Up/Alt+Down||Move the selected run/debug configuration up and down in the list.
The order of configurations in the list defines the order in which the configurations appear in the corresponding list on the main toolbar.
|You can group run/debug configurations by placing them into folders.
To create a folder, select the configurations to be grouped and click . Specify the name of the folder.
Then, to move a configuration into a folder, between the folders or out of a folder, use and . You can also drag a configuration into a folder.
To remove grouping, select a folder and click .
See also, Creating Folders and Grouping Run/Debug Configurations.