IntelliJ IDEA 2024.3 Help

Application Servers

Use this page or dialog to manage configurations for the supported application servers and their settings.

The servers that are already defined in IntelliJ IDEA are shown in the pane under the Add button and the Remove button. When you select a server in this pane, the corresponding configuration settings and associated controls are shown in the area to the right. (If you are editing a run configuration for a particular server (for example, Tomcat), only the existing configurations for this particular server are shown.)

Use the Add button to create server configurations and the Remove button to remove them.

By the time you start creating a server configuration, the corresponding server must already be installed on your computer.

Note that the list of servers you can work with depends on which server integration plugins are currently enabled.

Toolbar

Item

Description

the Add button Alt+Insert

Use this icon or shortcut to create a server configuration (that is, to define a server in IntelliJ IDEA):

  1. If the server list is shown, select the server of interest.

  2. In the dialog that opens, specify the server settings and click OK.

    For most of the servers, you just need to specify the server installation directory (referred to as the server home). For more information, refer to Main settings and controls.

the Remove button Alt+Delete

Use this icon or shortcut to remove the selected application server configuration.

Main settings and controls

Item

Description

Name

The server configuration name.

<Server> Home

The path to the application server installation folder.

Click the Browse button and select the necessary folder.

<Server> Version

The detected application server version (readonly).

<Server> base directory (for Tomcat and TomEE)

The path to the server base directory.

Click the Browse button and select the directory in the dialog that opens.

Register schemas (for JBoss)

To be able to validate JBoss XML configuration files (such as standalone.xml, domain.xml, and so on) when editing them in IntelliJ IDEA, you can register XML schemas (XSDs) available in the JBoss installation:

  1. Click Register schemas.

  2. To register all the schemas, just click OK in the dialog that opens.

    If there are schemas that you don't want to register, select those schemas under External Schemas and DTDs, click the Remove button and then click OK.

To view or edit the schema list at a later time, use the Schemas and DTDs page in the Settings dialog.

See also, Libraries and Additional Libraries for Frameworks.

Libraries

When you create a server configuration, normally, an associated application server library is created. As a rule, this library includes Servlet, JSP and EJB implementations available in the server distribution.

Use the controls under Libraries to manage the contents of the library.

Item

Description

the Add button Alt+Insert

Add items (classes, sources, documentation, and so on) to the library.

In the dialog that opens, select the necessary files and folders. These may be individual class and java files as well as directories and archives jar and zip containing such files.

IntelliJ IDEA will analyze the selected files and folders, and automatically assign their contents to the appropriate library categories (Classes, Sources, Documentation, and so on).

When IntelliJ IDEA cannot guess the category (for example, when you select an empty folder), a dialog will be shown, in which you will be able to specify the category yourself.

the Specify Documentation URL button

To be able to use external documentation available online, click this icon and specify the URL of the external documentation.

the Execute button

Exclude an item (refer to Exclude library items). In the dialog that opens, select the items that you want IntelliJ IDEA to ignore (folders, archives and folders within the archives), and click OK.

the Remove button Delete

This option allows you to:

  • Remove the selected ordinary library from the library.

  • Restore the selected excluded items. The items themselves will stay in the library.

Additional Libraries for Frameworks

For certain application server configurations, there is an Additional Libraries for Frameworks list with checkboxes.

Each item in this list, potentially, is a library that implements the corresponding framework. (Corresponding library files are included in the server distribution.)

When you select a checkbox in the list, the corresponding application server library is created. The dialog that opens lets you select the modules in which this library should be used. (As a result, the library is added to dependencies of the selected modules.)

Last modified: 08 October 2024