PhpStorm 2019.1 Help

Customizing Upload/Download

In addition to the mandatory settings that ensure successful upload and download in various project – server set-ups, you can choose additional options to customize interaction with the server. Most of these options apply to all server access configuration types. For FTP/FTPS/SFTP server configurations, you can specify additional protocol-specific options.

Set common upload/download options

  1. Open the Options dialog by doing one of the following:

    • On the main menu, choose Tools | Deployment | Options.

    • In the Settings/Preferences dialog (Ctrl+Alt+S), go to Build, Execution, Deployment | Deployment | Options.

  2. In the Options dialog that opens, specify additional settings:

    • To have PhpStorm skip specific files or entire folders during upload/download, in the Exclude items by name field, specify the patterns that define the names of these files and folders.

      Use semicolons as delimiters. Wildcards are welcome.

      The exclusion is applied recursively. This means that if a matching folder has subfolders, the contents of these subfolders are not deployed either.

      For more details about excluding files and folders from upload/download, see Excluding Files and Folders from Upload/Download.

    • Specify the details of the upload/download procedure by selecting or clearing the corresponding checkboxes.

Specify additional protocol-specific customization options for FTP/SFTP/FTPS servers

  1. Open the Deployment dialog by doing one of the following:

    • Choose Tools | Deployment | Configuration on the main menu.

    • In the Settings/Preferences dialog (Ctrl+Alt+S), go to Build, Execution, Deployment | Deployment.

  2. In the Deployment dialog, expand the Advanced area and specify additional uploading settings:

    • To set the client to the passive mode, select the Passive mode checkbox. In this mode, the client on your machine 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.

    • To have the hidden files and directories (with names starting with a dot .) shown in the Server Browser Tool Window, select the Show and process hidden files checkbox.

    • Select the Compatible with old version of listing children checkbox in the Use LIST command area 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.

    • Select the Instead of MLSD checkbox in the Use LIST command area 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.

    • Use the Retrieve files timestamps 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.

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

    • In the Encoding for client-server communication 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.

    • In the Send keep alive messages each field, specify how often you want PhpStorm to send commands to the server to reset the timeout and thus preserve the connection.

    • From the Keep alive command list, choose the commands to be sent to the server to reset the timeout and thus preserve the connection.

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

      To suppress showing the information popup, select the Ignore info messages checkbox.

Last modified: 26 July 2019

See Also

Language and Framework-Specific Guidelines: