IntelliJ IDEA 2024.1 Help

Create a local server configuration

A local server is a server that runs in a local or mounted folder and serves files to a local URL address. In a local server configuration, you do the development in a IntelliJ IDEA project, and then upload the project files to the document root on the server.

To create a local server configuration in IntelliJ IDEA, you need to set up connection between IntelliJ IDEA and the server and configure mapping between the IntelliJ IDEA project and the project folder on the server and its corresponding URL path.

Enable the FTP/SFTP/WebDAV Connectivity plugin

This functionality relies on the FTP/SFTP/WebDAV Connectivity plugin, which is bundled and enabled in IntelliJ IDEA by default. If the relevant features aren't available, make sure that you didn't disable the plugin.

  1. Press Ctrl+Alt+S to open settings and then select Plugins.

  2. Open the Installed tab, find the FTP/SFTP/WebDAV Connectivity plugin, and select the checkbox next to the plugin name.

1. Specify the name, type, and visibility of a server configuration

  1. Press Ctrl+Alt+S to open settings and then select Build, Execution, Deployment | Deployment.

    Alternatively, go to Tools | Deployment | Configuration... in the main menu.

  2. In the left-hand pane that lists all the existing server configurations, click Add Add item and select Local or mounted folder in the popup menu.

    Add local or mounted folder
  3. In the Create new server dialog that opens, type the name of the server to create and click OK. The Create new server dialog closes and you return to the Connection tab of the Deployment node.

  4. Click the Use as default button on the toolbar to mark the server as default.

  5. Clear the Visible only for this project checkbox to enable reuse of this server access configuration in other projects.

2. Set up connection to the server

In the Connection tab (Ctrl+Alt+S | Build, Execution, Deployment | Deployment), specify the server settings:

  • Folder: specify the absolute path to the server document root as defined in your server configuration file. Besides the document root itself, any other existing folder under the document root can also be specified.

    The document root is the folder from which the web server serves files to the web server URL.

  • Web server URL: the URL address (hostname and (optionally) port) mapped to the server document root in the server configuration file. This is the base URL for your application's web address. Both HTTP and HTTPS are supported.

    Click Browse in the right-hand corner of the field to open and check the provided web server URL.

3. Map project folder to a server folder and URL path

In the Mappings tab (Ctrl+Alt+S | Build, Execution, Deployment | Deployment), specify the mapping between the project opened in IntelliJ IDEA and the folder under the server document root that shall correspond to it:

Deployment Mappings tab
  • Local path: the absolute path to the local project folder. IntelliJ IDEA automatically fills out this field with the path to the currently opened project.

  • Deployment path: a folder under the server document root where IntelliJ IDEA will upload the contents of the project folder specified in the Local path field.

    If a folder with the specified name does not yet exist on the server, IntelliJ IDEA will create it when you trigger project upload.

    The easiest way is to map the entire project root folder to a folder under the server document root. The project folder structure in this case will be recreated on the server.

  • Web path: the URL path configured for the folder specified in Deployment path. You can use a slash (/) to point to the root folder, or leave the field blank if the directory is not accessible from the web.

Last modified: 03 July 2024