IntelliJ IDEA 2018.2 Help

Run/Debug Configuration: Resin

Run | Edit Configurations | new | Resin | Local or Remote


Resin run/debug configurations let you deploy and debug your applications on Resin. (The Resin Integration plugin must be enabled.)

See also, Working with Server Run/Debug Configurations.

Server tab for a local configuration

ItemDescription
Application server Select the server configuration to be used.

Click Configure to create a new server configuration or edit an existing one. (The Application Servers dialog will open.)

After launch Select this checkbox to start a web browser after starting the server and deploying the artifacts.

Select the browser from the list. Click browseButton (Shift+Enter) to configure your web browsers.

With JavaScript debugger If this checkbox is selected, the web browser is started with the JavaScript debugger enabled.

Note that JavaScript debugging is available only for Firefox and Google Chrome. When you debug your JavaScript in Firefox for the first time, the JetBrains Firefox extension is installed.

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.
VM optionsIf necessary, specify the command-line options to be passed to the server JVM at the server start.

If you need more room to type, click shift enter button next to the field to open the VM Options dialog where the text entry area is larger.

When specifying JVM options, follow these rules:

  • Use spaces to separate individual options, for example, -client -ea -Xmx1024m.
  • If an option includes spaces, enclose the spaces or the argument that contains spaces in double quotes, for example, some" "arg or "some arg".
  • If an option includes double quotes (as part of the argument), escape the double quotes using backslashes, for example, -Dmy.prop=\"quoted_value\".
  • You can pass environment variable values to custom Java properties. For example, if you define a variable MY_ENV_VAR, you can pass it to the foo property as follows:
    -Dfoo=${MY_ENV_VAR}
On 'Update' action Select the necessary option for the Update application function (update icon or N/A in the Run or Debug tool window).

The update options are different for exploded and packed artifacts.

For exploded artifacts, the available options are:

  • Update resources. All changed resources are updated (HTML, JSP, JavaScript, CSS and image files).
  • Update classes and resources. Changed resources are updated; changed Java classes (EJBs, servlets, etc.) are recompiled.

    In the debug mode, the updated classes are hot-swapped. In the run mode, IntelliJ IDEA just updates the changed classes in the output folder. Whether such classes are actually reloaded in the running application, depends on the capabilities of the runtime being used.

  • Redeploy. The application artifact is rebuilt and redeployed.
  • Restart server. The server is restarted. The application artifact is rebuilt and redeployed.

For packed artifacts, the available options are:

  • Hot swap classes. Changed classes are recompiled and reloaded at runtime. This option works only in the debug mode.
  • Redeploy. The application artifact is rebuilt and redeployed.
  • Restart server. The server is restarted. The application artifact is rebuilt and redeployed.
Show dialog Select this checkbox if you want to see the Update dialog every time you use the Update application function.

The Update dialog is used to select the Update option prior to actually updating the application.

On frame deactivation Specify what IntelliJ IDEA should do when you switch from the IDE to a different application (for example, a web browser). (Frame deactivation means switching to a different application.)

The options other than Do nothing have the same meanings as in the case of the Update action.

JRE By default, the project JDK is used to run the application. If you want to specify an alternative JDK or JRE here, select it from the drop-down list.
Resin configuration template Specify the location of the Resin configuration template. You can click browseButton and select the necessary file in the dialog that opens.
Additional Resin command lineIf necessary, specify additional commands for the server.

If you need more room to type, click shift enter button next to the field to open the Additional Resin command line dialog where the text entry area is larger.

Do not alter Resin configurationSelect this checkbox to disallow editing the Resin configuration file.
CharsetSpecify the character set to be used.
JMX port Specify the JMX server port.
Deploy modeSelect the deploy-mode (startup-mode) for applications on the server.
HTTP port The server HTTP port. You may want to change the default port 80 (e.g. to 8080).

Server tab for a remote configuration

ItemDescription
Application server Select the server configuration to be used. Note that this is a local server configuration. (When working with a remote server, the same server version must be available locally.)

Click Configure to create a new server configuration or edit an existing one. (The Application Servers dialog will open.)

After launch Select this checkbox to start a web browser after connecting to the server and deploying the artifacts.

Select the browser from the list. Click browseButton (Shift+Enter) to configure your web browsers.

With JavaScript debugger If this checkbox is selected, the web browser is started with the JavaScript debugger enabled.

Note that JavaScript debugging is available only for Firefox and Google Chrome. When you debug your JavaScript in Firefox for the first time, the JetBrains Firefox extension is installed.

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.
On 'Update' action Select the necessary option for the Update application function (update icon or N/A in the Run or Debug tool window).

The options are:

  • Hot swap classes. Changed classes are recompiled and reloaded at runtime. This option works only in the debug mode.
  • Redeploy. The application artifact is rebuilt and redeployed.
Show dialog Select this checkbox if you want to see the Update dialog every time you use the Update application function.

The Update dialog is used to select the Update option prior to actually updating the application.

On frame deactivation Specify what IntelliJ IDEA should do when you switch from the IDE to a different application (for example, a web browser). (Frame deactivation means switching to a different application.)

The options other than Do nothing have the same meanings as in the case of the Update action.

CharsetSpecify the character set to be used.
JMX port Specify the JMX server port.
PingClick this button to ping the JMX port on the server.
Remote staging This section contains the settings related to staging. An example of remote staging settings for a mounted folder is provided after this table.
Type Select the way the staging environment or host is accessed for transferring the application artifact or artifacts from your local computer. (In the user interface of IntelliJ IDEA this setting is also referred to as the connection type.)

The available options are:

  • Same file system. Select this option if the target server is installed on your local computer. The artifacts in this case are deployed locally and, thus, don't need to be transferred to a remote host.
  • ftp. The File Transfer Protocol or Secure FTP is used.
  • Local or mounted folder. The staging environment is a local folder or is accessed as a mounted folder.

If the list is empty, you have to enable the Remote Hosts Access plugin which supports the corresponding functionality.

HostIf Same file system is selected for Type, the only available option for Host is also Same file system.

In all other cases, the list contains the existing configurations of the selected type. So each configuration corresponds to an individual (S)FTP connection, or a local or mounted folder.

Select an existing configuration or create a new one.

To create a new configuration:

  1. Click browseButton to the right of the list.
  2. In the Deployment dialog, click new.
  3. In the Add Server dialog, specify the configuration name, select the type, and click OK.
  4. On the Connection tab, specify the settings in the Upload/download project files section.

    The rest of the settings don't matter.

  5. Click OK in the Deployment dialog.

Path from rootThe path to the staging folder relative to the local or mounted folder, or the root of the (S)FTP host.

You can use browseButton to select the folder in the Choose target path dialog.

Note that if Same file system is selected for Type and Host, this setting doesn't need to be specified.

Remote connection settings The settings for accessing deployed applications.
Host The fully qualified domain name or the IP address of the Resin host.
Port The server HTTP port.

An example of remote staging settings for a mounted folder

Assuming that:

  • C:\shared is a shared folder on the remote host which is mounted to the local computer as the drive X:.
  • The folder that you are going to use for staging is C:\shared\staging.

Here are the corresponding remote staging settings:

  • Type: Local or mounted folder.
  • Host: The configuration should be selected in which the value in the Folder field is X:\ (the Upload/download project files section on the Connection tab of the Deployment dialog).
  • Path from root: staging

Deployment tab

Use this tab to specify which artifacts and/or external resources should be deployed onto the server. (An external resource means a deployable Web component such as a .war file which is not represented by a project artifact. Usually, such components are stored outside of the project scope.)

To add items to the deployment list (shown under Deploy at the server startup), use new. To edit the settings for an artifact or external resource, select the corresponding item in the list and use the controls in the right-hand part of the tab. For more information, see the table below.

ItemDescription
new or Alt+Insert Use this icon or shortcut to add an artifact or an external resource to the list.
  • To add an artifact, select Artifact and choose the desired artifact in the dialog that opens.
  • To add an external resource, select External Source and choose the location of the desired resource in the dialog that opens.
icons general remove svg or Alt+DeleteUse this icon or shortcut to remove the selected artifacts and external resources from the list.
icons actions edit svg or F4 Use this icon or shortcut to configure the selected artifact. (The Artifacts page of the Project Structure dialog will open.)
Deployment method For local configurations: select the deployment method for the selected artifact or external resource (JMX or resin.xml).
Resin host name For local configurations: specify the name or the IP address of the Resin host (for example, localhost or 127.0.0.1).
Use default context name For local configurations: select this checkbox if you want to use the default context root for the selected artifact or external resource. Otherwise, clear this checkbox and specify the context root in the Application context name field.

Note that if the deployment method is JMX, the default context root is always used.

Application context name For local configurations: specify the context root for the selected artifact or external resource.

Logs tab

Use this tab to specify which log files generated while running or debugging should be displayed in the console, that is, on the dedicated tabs of the Run or Debug tool window.

ItemDescription
Is ActiveSelect check boxes in this column to have the log entries displayed in the corresponding tabs in the Run tool window or Debug tool window.
Log File Entry

The read-only fields in this column list the log files to show. The list can contain:

  • Full paths to specific files.
  • Ant patterns that define the range of files to be displayed.
  • Aliases to substitute for full paths or patterns. These aliases are also displayed in the headers of the tabs where the corresponding log files are shown.

    If a log entry pattern defines more than one file, the tab header shows the name of the file instead of the log entry alias.

Skip ContentSelect this check box to have the previous content of the selected log skipped.
Save console output to fileSelect this check box to save the console output to the specified location. Type the path manually, or click the browse button and point to the desired location in the dialog that opens.
Show console when a message is printed to standard output streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.out.
Show console when a message is printed to standard error streamSelect this check box to activate the output console and bring it forward if an associated process writes to Standard.err.
icons general add svgClick this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.
icons actions edit svgClick this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.
icons general remove svgClick this button to remove the selected log entry from the list.

Code Coverage tab

Use this tab to configure code coverage monitoring options.

Note that this tab is not available for remote servers.

ItemDescription
Choose code coverage runnerSelect the desired code coverage runner.
SamplingSelect this option to measure code coverage with minimal slow-down.
TracingSelect this option to collect accurate branch coverage. This mode is available for the IntelliJ IDEA code coverage runner only.
Track per test coverageSelect this checkbox to detect lines covered by one test and all tests covering line.
Packages and classes to record code coverage dataIf necessary, specify the classes and packages to be measured.

Use icons toolbarDecorator addClass or icons toolbarDecorator addPackage to add classes or packages to the list.

To remove the classes or packages from the list, select the corresponding list items and click icons general remove svg.

Enable coverage in test folders.Select this checkbox to include the test source folders in code coverage analysis.

Startup/Connection tab for a remote configuration

This tab shows command-line options for starting the server JVM in the run and debug modes.

ItemDescription
run Run /
icons actions startDebugger svg Debug
Use to switch between the settings for the run and debug modes. The settings are shown in the area under To run/debug...
To run/debug remote server JVM... The command-line options for starting the server JVM. These are shown just for copying elsewhere.
Transport (and all that follows) The GUI for generating the remote debug command-line options shown in the area under To run/debug...

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 (Shift+Alt+F10).
Share Select this check box to make the run/debug configuration available to other team members.

If the directory-based project format is used, the settings for a run/debug configuration are stored in a separate .xml file in the .idea\runConfigurations folder if the run/debug configuration is shared, or in the .idea\workspace.xml file otherwise.

If the file-based format is used, the settings are stored in the .ipr file for shared configurations, or in the .iws file otherwise.

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 svgAlt+InsertCreate a run/debug configuration.
icons general remove svgAlt+Delete Delete the selected run/debug configuration. Note that you cannot delete default configurations.
icons actions copy svg Ctrl+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 svgAlt+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 when you choose a run/debug configuration.

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

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 to be grouped, click folder, and specify the name for the folder. 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 alphabetical order.

Templates

When you select Templates in the tree view of the run configurations, you can adjust some settings that apply for 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 — tool window that helps you execute and manage multiple run/debug configurations.

Note that the dashboard will only display those configuration types for which you have created one ore more configurations.
So 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 checkbox is selected for a particular run/debug configuration.
  • If this checkbox is selected, then, in case of a single instance, launching a new process (for example, by clicking run 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), IntelliJ IDEA starts the new process silently.
Temporary configurations limit Specify here 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 should be carried out before starting the selected run/debug configuration. The specified tasks are performed in the order they appear in the list.

ItemShortcutDescription
icons general add svgAlt+Insert Click this icon to add one of the following available tasks:
  • Run External tool — select this option to run an application which is external to IntelliJ IDEA. In the dialog that opens, select the application or applications that should be run. If the necessary application is not defined in IntelliJ IDEA yet, add its definition. For more information, see Configuring Third-Party Tools and External Tools.
  • Make — select this option to have the project or module compiled. The Make Module command will be carried out if a particular module is specified in the run/debug configuration, and the Make Project command otherwise.

    If an error occurs during the compilation, IntelliJ IDEA won't attempt to start the run/debug configuration.

  • Make, no error check — the same as the Make option but IntelliJ IDEA will try to start the run/debug configuration irrespective of the compilation result.
  • Build Artifacts — select this option to build an artifact or artifacts. In the dialog that opens, select the artifact or artifacts that should be built.
  • Run Another Configuration — select this option to execute another run/debug configuration. In the dialog that opens, select the configuration to be run.
  • Run Ant target — select this option to run an Ant target. In the dialog that opens, select the target 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 Maven Goal — select this option to run a Maven goal. In the dialog that opens, select the goal to be run.
  • 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 — elect this option 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.
  • Run Remote External tool — adds a remote SSH external tool.
  • Run Rake task — add a Rake task to be executed prior to running or debugging. To choose a Rake task, click the browse button browseButton, and select the desired task from the list of available tasks.

    Note that code completion is available here.

    runConfigRakeTask
  • Run JRuby compiler: choose this option to execute JRuby compiler with the specified target path, compiler process heap size, and command line parameters (if any).
icons general remove svgAlt+Delete Click this icon to remove the selected task from the list.
icons actions edit svg Enter Click this icon to edit the selected task. Make the necessary changes in the dialog that opens.
icons actions moveUp svg/icons actions moveDown svgAlt+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

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 Alt+4 or Alt+5.

Last modified: 18 June 2018

See Also