PhpStorm 2016.1 Help

Create New Project: Add Remote Server

File | New Project From Existing Files - Web server is installed locally, source files are located elsewhere locally
File | New Project From Existing Files - My web server is on remote host, files are accessible via network share or mounted drive
File | New Project From Existing Files - My web server is on remote host, files are accessible via FTP/SFTP/FTPS


The page opens if you have selected the Add new remote server option on the Create New Project: Specify Remote Server page. On this page, specify a new configuration of settings to connect and authenticate to a remote server.

ItemDescriptionAvailable for
NameIn this text box, type the name of the new remote server configuration.FTP, FTPS, SFTP
Access type From this drop-down list, choose the way to access the server. Use the Up and Down keyboard keys to scroll through the list of server configuration types. 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.
FTP, FTPS, SFTP
FTP/SFTP/FTPS hostIn this text box, specify the host name of the FTP/SFTP/FTPS server to download the files from.FTP, FTPS, SFTP
PortIn this text box, specify the port to use. The default values are:
  • 21 for FTP and FTPS
  • 22 for SFTP
FTP, FTPS, SFTP
User nameIn this text box, type your user name for authentication to the server.FTP, FTPS, SFTP
Log in as anonymousSelect this check box to enable anonymous access to the server with your email address as password.FTP, FTPS, SFTP
Auth typeFrom this drop-down list, select the client authentication method. The available options are:
  • Password - select this option to use standard authentication through a password.
  • Key pair (OpenSSH) - select this option to use SSH authentication via a key pair.
SFTP
PasswordIn this text box, type your password for authentication to the server.FTP, FTPS, SFTP
Private key fileIn this text box, specify the location of your private key file. FTP, FTPS, SFTP
PassphraseIn this text box, specify your authentication passphrase. SFTP
Save passwordSelect this check box to have PhpStorm remember the specified password.FTP, FTPS, SFTP
Save passphraseSelect this check box to have PhpStorm remember the specified passphrase. SFTP
Test FTP/SFTP/FTPS connectionClick this button to check that the specified settings ensure successful connection via FTP/SFTP/FTPS.FTP, FTPS, SFTP
Root path In this text box, 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 value /, which points at the user home folder on the server.
  • Type the path manually.
  • Click the Browse button browseButton.png and select the desired folder in the Choose Root Path dialog box 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.
FTP, FTPS, SFTP
AutodetectClick this button to have PhpStorm detect the user home folder settings on the FTP/SFTP/FTPS server and set up the root path according to them.FTP, FTPS, SFTP
Explicit Choose this option to have the explicit (active) security 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. FTPS
Implicit Choose this option to have the implicit (passive) security applied. In this case, security is provided automatically upon establishing connection to the server which appoints a separate port for secure connections. FTPS
Advanced options Click this button to specify the following additional uploading settings in the Advanced Options dialog box that opens. The set of controls in the dialog box depends on the server access type, for details, see Advanced Options Dialog. FTP, FTPS, SFTP
Web server root URL In this text box, specify the URL address of the Web server root folder. Both the HTTP and the HTTPS protocols are supported.

To access a server through HTTPS, you need to acquire a certificate file <certificate_name>.cert signed by a recognized authority and import this certificate in the truststore/keystore of the Oracle JRE (Java Runtime Environment) on which PhpStorm runs. Note that self-signed certificates are rejected as unsafe.

To import a certificate in Oracle JRE:

  1. Open the embedded Terminal and type the following command:
    <jre_home>/bin/keytool.exe -importcert -keystore <path to jre truststore/keystore> -file <full_path_to_<cert_name>.cert>
    If you are using the Oracle JRE bundled with PhpStorm, the default path to the truststore/keystore is <%product_installation_folder>/jre/jre/lib/security/jssecacerts or <%product_installation_folder>/jre/jre/lib/security/cacerts.

    Otherwise it is <jre_home>/jre/lib/security/jssecacerts or <jre_home>/jre/lib/security/cacerts.

  2. When asked to enter a password for the truststore/keystore, specify the default one changeit.
  3. Open the PhpStorm.exe.vmoptions file in the <PhpStorm_installation_folder>/bin and add the following line to it:
    -Djavax.net.ssl.keyStore=<path to keystore>
  4. Restart PhpStorm.
Learn more at Java6 and Java7.

FTP, FTPS, SFTP
OpenClick this button to make sure that the specified server root URL address is accessible and points at the correct Web page.FTP, FTPS, SFTP
Don't check HTTP connection to server
  • When this check box is cleared, PhpStorm checks whether the specified URL address ensures successful connection to the server. Both the HTTP and the HTTPS protocols are supported.

    To access a server through HTTPS, you need to acquire a certificate file <certificate_name>.cert signed by a recognized authority and import this certificate in the truststore/keystore of the Oracle JRE (Java Runtime Environment) on which PhpStorm runs. Note that self-signed certificates are rejected as unsafe.

    To import a certificate in Oracle JRE:

    1. Open the embedded Terminal and type the following command:
      <jre_home>/bin/keytool.exe -importcert -keystore <path to jre truststore/keystore> -file <full_path_to_<cert_name>.cert>
      If you are using the Oracle JRE bundled with PhpStorm, the default path to the truststore/keystore is <%product_installation_folder>/jre/jre/lib/security/jssecacerts or <%product_installation_folder>/jre/jre/lib/security/cacerts.

      Otherwise it is <jre_home>/jre/lib/security/jssecacerts or <jre_home>/jre/lib/security/cacerts.

    2. When asked to enter a password for the truststore/keystore, specify the default one changeit.
    3. Open the PhpStorm.exe.vmoptions file in the <PhpStorm_installation_folder>/bin and add the following line to it:
      -Djavax.net.ssl.keyStore=<path to keystore>
    4. Restart PhpStorm.
    Learn more at Java6 and Java7.

  • When this check box is selected, PhpStorm moves to the next page of the Wizard without any connection check.
FTP, FTPS, SFTP

See Also

Last modified: 12 July 2016