Professional

Deployment: Connection Tab

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.

  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 icon.

• When the checkbox is cleared, the configuration or server group is visible in all PyCharm projects. Its settings can be reused across several projects.

For details on setting up interpreters, see Node.js via SSH.

Type

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

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

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

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

• WebDAV: choose this option to have PyCharm access the server via the WebDAV file transfer protocol (the WebDAV 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 in the field to make sure the specified server root URL address is accessible and points at the correct web page.

Both the HTTP and the HTTPS protocols are supported.

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 the root folder on the server. 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 root folder on the server.

• Type the path manually or click and select the desired folder in the Choose Root Path dialog that opens.

• Click Autodetect. PyCharm detects the user home folder settings on the FTP/SFTP server and sets up the root path according to them. The button is only enabled when you have specified your credentials.

Autodetect

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

User name

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

Password

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

Login 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 PyCharm 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.

SSH configuration

From this list, choose one of the created SSH configurations, or click and create a new configuration as described in Create SSH configurations.

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.

Root path

In this field, specify the server configuration root relative to the root folder on the server. 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 root folder on the server.

• Type the path manually or click and select the desired folder in the Choose Root Path dialog that opens.

• Click Autodetect. PyCharm detects the user home folder settings on the FTP/SFTP server and sets up the root path according to them. The button is only enabled when you have specified your credentials.

Use Rsync for download / upload / sync

Select this checkbox to use Rsync to synchronize your deployment configuration.

note

Rsync is used for upload and download operations. All other deployment-related operations, including accessing files on a remote host, comparing deployed files and folders with their local versions, and so on, are performed via SFTP.

Rsync Settings

Click this link to configure Rsync settings in the dialog that opens:

• Provide the paths to the rsync and ssh executables.

  • On macOS and Linux, the rsync and ssh tools are preinstalled and their paths are filled automatically.

  • On Windows, you need to manually install Cygwin with the rsync and openssh packages first. The tools' executables are commonly located in the <Cygwin installation>\bin folder.

• If necessary, override the Rsync command-line parameters in the Rsync options field.

  By default, the -zar options are used, so that Rsync will compress the transferred data (z), preserve permissions, ownership, and timestamps of transferred files and folders (a), and recurse into subdirectories (r).

  For the complete list of available options, refer to the Rsync documentation.

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 6180.

User name

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

Password

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

Login as anonymous

Select this checkbox to enable anonymous access to the server.

Save password

Select this checkbox to have PyCharm remember the specified password.

Test Connection

Click this button to check that the specified settings ensure successful connection.

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 server as defined in the server configuration file. However, you can appoint any other existing folder under the document root.