Run/Debug Configuration: Spring DM Server (Remote)
Note that if you are starting the server by means of the default script
startup.sh, you should properly set the environment variable
- Name field and Share option
- Server tab for a remote configuration
- Deployment tab
- Logs tab
- Startup/Connection tab for a remote configuration
- Before Launch options
See also, Working with Server Run/Debug Configurations.
Name field and Share option
|Name||Use this field to edit the name of the run/debug configuration. |
This field is not available when editing the run/debug configuration defaults.
|Share|| Select this checkbox 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
If the file-based format is used, the settings are stored in the
This checkbox is not available when editing the run/debug configuration defaults.
Server tab for a remote configuration
|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 (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.|
|On 'Update' action|| Select the necessary option for the Update application function ( or Ctrl+F10 in the Run or Debug tool window). |
The options are:
|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.
|JMX Port||Specify the JMX server port.|
|Ping||Click this button to ping the JMX port on the server.|
|JMX User||Specify the name of the user on whose behalf IntelliJ IDEA will connect to the JMX server port.|
|JMX Password||Specify the password of the JMX user.|
|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:
If the list is empty, you have to enable the Remote Hosts Access plugin which supports the corresponding functionality.
|Host||If 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:
|Deployment access||When deploying to the remote host, the application artifact or artifacts are placed into a staging folder (deployment target folder). This folder should be accessible to the server. The settings in this section define the location of this staging folder.|
|Path from root||The path to the staging folder relative to the local or mounted folder, or the root of the (S)FTP host.|
|Mapped as|| The absolute path to the staging folder in the local file system of the remote host. |
The path should be specified as a URL, e.g.
|Repository access||When deploying to the remote host, the plans (artifacts) are placed into a watched repository. The settings in this section describe this repository.|
|Path from root||The path to the repository folder relative to the local or mounted folder, or the root of the (S)FTP host.|
|Name||Specify the name of the watched repository the way it is defined in the configuration of the remote server.|
|Remote connection settings||The settings for accessing deployed applications.|
|Host||The fully qualified domain name or the IP address of the server host.|
|Port||The server HTTP port.|
An example of remote staging settings for a mounted folder
C:\sharedis a shared folder on the remote host which is mounted to the local computer as the drive
- The folder that you are going to use for staging is
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).
- Staging/Path from root:
- Staging/Mapped as:
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 . 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.
|or Alt+Insert|| Use this icon or shortcut to add an artifact or an external resource to the list. |
|or Alt+Delete||Use this icon or shortcut to remove the selected artifacts and external resources from the list.|
|or F4||Use this icon or shortcut to configure the selected artifact. (The Artifacts page of the Project Structure dialog will open.)|
|Is Active||Select checkboxes 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: |
|Skip Content||Select this checkbox to have the previous content of the selected log skipped.|
|Save console output to file||Select this checkbox 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 stream||Select this checkbox 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 stream||Select this checkbox to activate the output console and bring it forward if an associated process writes to Standard.err.|
|Click this button to open the Edit Log Files Aliases dialog where you can select a new log entry and specify an alias for it.|
|Click this button to edit the properties of the selected log file entry in the Edit Log Files Aliases dialog.|
|Click this button to remove the selected log entry from the list.|
|Click this button to edit the select log file entry. The button is available only when an entry is selected.|
Startup/Connection tab for a remote configuration
This tab shows command-line options for starting the server JVM in the run and debug modes.
| Run /|
|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...|
Before Launch options
Specify which tasks should be carried out before starting the run/debug configuration.
|Alt+Insert|| Click this icon to add a task to the list. Select the task to be added, for example: |
|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 checkbox to show the run/debug configuration settings prior to actually starting the run/debug configuration.|
|Activate tool window|| If this checkbox is selected, 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 if necessary.