PhpStorm 2018.3 Help

Deployment: Connection Tab

Use this tab to choose the way to access the Web server and specify the connection settings. The set of controls depends on the chosen server access type.

Settings common for all server types

Item

Description

Visible only for this project

Use this checkbox to configure the visibility of the server access configuration or server group.

  • Select the checkbox to restrict the use of the configuration or server group to the current project. Such configuration or server group cannot be reused outside the current project. It does not appear in the list of available configurations in other projects. For example, if this checkbox is selected in an SFTP configuration, you cannot use its SSH credentials for configuring a remote interpreter.

    The server records are stored in the .idea directory together with the project, which allows sharing them between team members through a VCS.

    In the server access configurations list in the left-hand pane, the configurations visible only in the current project are marked with the Visible only in current project icon icon.

  • When the checkbox is cleared, the configuration or server group is visible in all PhpStorm projects. Its settings, including SSH credentials for SFTP servers, can be reused across several projects.

For details on setting up interpreters, see Configuring Remote Node.js Interpreters and Configuring Remote PHP Interpreters for details.

Type

In this list, choose the way to access the server. The available options are:

  • FTP: choose this option to have PhpStorm access the server via the FTP file transfer protocol.

  • SFTP: choose this option to have PhpStorm access the server via the SFTP file transfer protocol.

  • FTPS: choose this option to have PhpStorm access the server via the FTP file transfer protocol over SSL (the FTPS extension).

  • Local or mounted folder: choose this option if the Web server is running in a local or a mounted folder and its document root is NOT the parent of the project root.

  • In-place: choose this option if the Web server is running on your computer, your project is under its document root, and you do your development directly on the server.

Web server URL

In this field, specify the Web server root folder URL address. Click Open URL in browser icon in the field to make sure that the specified server root URL address is accessible and points at the correct web page.

Both the HTTP and the HTTPS protocols are supported.

FTP and FTPS settings

Item

Description

Host

In this field, specify the host name of the server to upload the files to.

Port

In this field, specify the port to use. The default value is 21.

Root Path

In this field, specify the server configuration root relative to your user home which was defined when you registered your account. This folder will be the highest one in the folder structure accessible through the current server configuration.

Do one of the following:

  • Accept the default / path, which points at the user home folder on the server.

  • Type the path manually.

  • Click Browse button and select the desired folder in the Choose Root Path dialog that opens.

  • Click the Autodetect button and have PhpStorm detect the user home folder settings on the FTP/SFTP server and set up the root path according to them. The button is only enabled when you have specified your user name and password.

Autodetect

Click this button to have PhpStorm detect the user home folder settings on the server and set up the root path accordingly.

User name

In this field, type your user name for authentication to the server.

Password

In this field, type your password for authentication to the server.

Log in as anonymous

Select this checkbox to enable anonymous access to the server with your email address as password.

Save password

Select this checkbox to have PhpStorm remember the specified password.

Test connection

Click this button to check that the specified settings ensure successful connection. The button is only enabled when you have specified your user credentials.

FTP and FTPS advanced settings

In the Advanced area, customize upload/download by specifying additional protocol-specific options for the FTP/FTPS server configurations.

Item

Description

Available for

TLS

Choose the method to invoke client security:

  • Explicit: the explicit (active) security is applied. Immediately after establishing connection, the FTP client on your machine sends a command to the server to establish secure control connection through the default FTP port.

  • Implicit: the implicit (passive) security is applied. In this case, security is provided automatically upon establishing connection to the server which appoints a separate port for secure connections.

    Note that the Implicit method is considered deprecated, and using it is discouraged.

FTPS

Data channel protection level

From this list, set the protection level for the PROT command:

  • <default>: the default server policy is applied.

  • Clear: raw data is transferred without applying security.

  • Private: the Transport Layer Security (TLS) or Secure Sockets Layer (SSL) applied.

For more information, see the articles on TLS, SSL 2.0, and SSL 3.0.

FTPS

Reuse SSL session

Select this checkbox to connect to a server that requires SSL session reuse between the control and data connections.

FTPS

Passive mode

Select this checkbox to set the client on your machine to passive mode, when it connects to the server to inform about being in the passive mode, receives the port number to listen to, and established data connection through the port with the received number. This mode is helpful when your machine is behind a firewall.

FTP, FTPS

Show and process hidden files

When this checkbox is selected:

  1. Hidden files and directories are shown in the Remote Host Tool Window.

  2. Hidden files and directories are involved in diff and synchronization operations.

The name of a hidden file or directory starts with a dot (.).

FTP, FTPS

Use LIST command

Use the options in this area to configure the LIST command usage.

  • Compatible with old version of listing children: Select this checkbox to ensure compatibility in child file naming with your FTP server.

    This option is helpful if the remote FTP server reports the following error:

    Invalid descendant file name <file name>
    Selecting this option may slow down synchronization with the server.

  • Instead of MLSD: Select this checkbox to use the standard LIST command for listing instead of the MLSD command. This lets you avoid problems, for example, failure during upload with the Invalid descendent file name exception if the FTP server supports MLSD and returns cdir.

FTP, FTPS

Concurrent connections limit

Select this checkbox to have PhpStorm restrict the number of connections to be supported simultaneously and specify the maximum number of allowed connections in the field.

FTP, FTPS

Retrieve files timestamps

Use this list to specify the MDTM FTP command calling policy to retrieve the last-modified time of a given file on the remote host.

The available options are:

  • Always - select this option to have MDTM called for every file shown in the Remote Host tool window.

  • On copy - select this option to have MDTM called in the following cases:

    • To check whether a file is up to date when the Overwrite up-to-date files checkbox in the Options dialog is cleared.

    • To preserve the actual time stamp of a file during download.

  • Never - select this option to suppress calling MDTM.

FTP, FTPS

Send keep alive message each

In this field, specify how often you want PhpStorm to send commands to the server to reset the timeout and thus preserve the connection.

FTP, FTPS

Keep alive command

From this list, choose the commands to be sent to the server to reset the timeout and thus preserve the connection.

FTP, FTPS

Encoding for client-server communication

In this field, specify the encoding that matches the encoding used by your server. Accept the default value if you are not sure that it supports UTF-8 encoding.

FTP, FTPS

SFTP settings

Item

Description

Host

In this field, specify the host name of the server to upload the files to.

Port

In this field, specify the port to use. The default value is 22.

Root Path

In this field, specify the server configuration root relative to your user home which was defined when you registered your account. This folder will be the highest one in the folder structure accessible through the current server configuration.

Do one of the following:

  • Accept the default / path, which points at the user home folder on the server.

  • Type the path manually.

  • Click Browse button and select the desired folder in the Choose Root Path dialog that opens.

  • Click the Autodetect button and have PhpStorm detect the user home folder settings on the FTP/SFTP server and set up the root path according to them. The button is only enabled when you have specified your user name and password.

Autodetect

Click this button to have PhpStorm detect the user home folder settings on the server and set up the root path accordingly.

User name

In this field, type your user name for authentication to the server.

Authentication

From this list, select the client authentication method. The available options are:

  • Password - select this option to use standard authentication through a password.

  • Key pair (OpenSSH or PuTTY) - select this option to use SSH authentication via a key pair.

    To apply this authentication method, you must have a private key on the client machine and a public key on the remote server. PhpStorm supports private keys that are generated with the OpenSSH utility.

  • OpenSSH config and authentication agent - select this option if your SSH keys are managed by a credentials helper application (for example, Pageant on Windows or ssh-agent on Mac and Linux).

See the Generating a new SSH key and adding it to the ssh-agent tutorial for details on working with SSH keys.

Password

In this field, type your password for authentication to the server.

Private key file

In this field, specify the location of your private key file.

Passphrase

In this field, specify your authentication passphrase.

Save password

Select this checkbox to have PhpStorm remember the specified password.

Save passphrase

Select this checkbox to have PhpStorm remember the specified passphrase.

Test connection

Click this button to check that the specified settings ensure successful connection. The button is only enabled when you have specified your user credentials.

SFTP advanced settings

In the Advanced area, customize upload/download by specifying additional protocol-specific options for the SFTP server configurations.

Item

Description

Concurrent connections limit

Select this checkbox to have PhpStorm restrict the number of connections to be supported simultaneously and specify the maximum number of allowed connections in the field.

Send keep alive message each

In this field, specify how often you want PhpStorm to send commands to the server to reset the timeout and thus preserve the connection.

Encoding for client-server communication

In this field, specify the encoding that matches the encoding used by your server. Accept the default value if you are not sure that it supports UTF-8 encoding.

Ignore info messages

On some SFTP servers, the SSH banner may be enabled. Every time a connection is established, a pop-up window with an information message may be shown and to continue you would need to click OK.

To suppress showing the information pop-up window, select the Ignore info messages checkbox.

Local or mounted folder settings

Item

Description

Folder

In this field, specify the server configuration root.

The server configuration root is the highest folder in the file tree on the server that can be accessed through the server configuration. The easiest way is to use the document root of your Web server as defined in the Web server configuration file. However you can appoint any other existing folder under the document root.

Last modified: 14 December 2018

See Also