AppCode 2018.2 Help

Run/Debug Configuration: Docker

Run | Edit Configurations | icons general add svg | 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.

For more information, see Running Docker images

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.
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.
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 file to use for this run configuration.

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 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 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.
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.
Command previewPreview the resulting command that will be used to execute the run configuration.

Common options

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

ItemDescription
Name In this text box, specify the name for the run/debug configuration. The name will help you identify the created configuration when you choose to edit it later, or when you invoke it, for example. from the Run popup (⌃⌥R).
Share Select this check box to make the run/debug configuration available to other team members.

The shared run/debug configurations are kept in separate xml files under .idea\runConfigurations folder, while the local run/debug configurations are kept in the .idea\workspace.xml.

Single instance only

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
icons general add svg⌘NCreate a run/debug configuration.
icons general remove svg⌘⌦ Delete the selected run/debug configuration. Note that you cannot delete default configurations.
icons actions copy svg ⌘D Create a copy of the selected run/debug configuration. Note that you create copies of default configurations.
icons general settings svg Edit Templates View and edit the default template for the selected run/debug configuration. The templates are used for newly created configurations.
icons actions moveUp svg/icons actions moveDown svg⌃↑/⌃↓

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 when you choose a run/debug configuration.

Default templates of run/debug configurations are always sorted alphabetically.

icons actions newFolder svg 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 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-and-drop or icons actions moveUp svg and icons actions moveDown svg buttons.

To remove grouping, select a folder and click icons general remove svg.

icons objectBrowser sorted svg Sort configurations Click this button to sort configurations in the alphabetical order.

Templates

Under the Templates node in the tree view of run configurations, you can select a run configuration template and edit its default settings. This will not affect the configurations that are already created, but will be used as defaults when creating new configurations of the corresponding type.

When you select the Templates node itself, you will be able to adjust general settings that apply to all run/debug configurations:

ItemDescription
Configurations available in Run Dashboard

In this section you can create a list of run configurations available in the Run Dashboard — a tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display the configuration types for which you have created one ore more configurations.
Thus, if you add a configuration type for which no configurations exist in the project, this type will not be displayed on the dashboard until you create a configuration of this type.

Confirm rerun with process terminationThe behavior of this checkbox depends on whether the Single instance only option is selected for a particular run/debug configuration.
  • If this checkbox is selected, in case of a single instance, launching a new process (for example, by clicking icons toolwindows toolWindowRun on the main toolbar) while another process is still running, results in showing a dialog box prompting to terminate the current process before launching a new one.
  • If this checkbox is not selected (or in case of multiple instances), AppCode starts the new process silently.
Temporary configurations limit Specify the maximum number of temporary configurations to be stored and shown in the Select Run/Debug Configuration drop-down list.

Before Launch options

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

ItemShortcutDescription
icons general add svg⌘N 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 AppCode yet, add its definition. For more information, see Configuring Third-Party 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 Grunt task: select this option to run a Grunt task. In the Grunt task dialog box 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 box 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 box that opens, specify the npm run/debug configuration settings.
  • 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.
icons general remove svg⌘⌦ Click this icon to remove the selected task from the list.
icons actions edit svg ⏎ Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
icons actions moveUp svg/icons actions moveDown svg⌃↑/⌃↓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 pageSelect this checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.
Activate tool window

If this checkbox is selected, which it is by default, the Run or the Debug tool window opens when you start the run/debug configuration.

Otherwise, the tool window isn't shown. However, when the configuration is running, you can open the corresponding tool window for it yourself by pressing ⌘4 or ⌘5.

Last modified: 16 August 2018
Run/Debug Configuration: CompoundRun/Debug Configuration: Firefox Remote

See Also

Procedures: