PyCharm 2020.1 Help

SSH Configurations

File | Settings | Tools | SSH Configurations for Windows and Linux
PyCharm | Preferences | Tools | SSH Configurations for macOS
Ctrl+Alt+S the Settings/Preferences icon

Use this page to create SSH configurations, which can be then used for configuring remote interpreters, connecting to SFTP deployment servers, and launching SSH sessions.

Toolbar

Item

Tooltip and Shortcut

Description

the Add button

Add

Insert

Click this button to create a new SSH configuration.

the Remove button

Delete

Alt+Delete

Click this button to remove the selected SSH configuration from the list. Note that this will affect the configured remote interpreters, SFTP deployment servers, and SSH sessions that depend on this configuration.

SSH Connection parameters

Item

Description

Visible only for this project

Use this checkbox to configure the visibility of the SSH configuration.

  • Select the checkbox to restrict the use of the SSH configuration to the current project. Such SSH configuration cannot be reused outside the current project. It does not appear in the list of available configurations in other projects.

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

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

Host

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

User name

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

Port

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

Local port

In this field, specify the outgoing port to use. The default value is <Dynamic>, and the port is selected automatically.

Authentication type

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

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

    • Password: in this field, type your password for authentication to the server.

    • Save password: select this checkbox to have PyCharm remember the specified 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. PyCharm supports private keys that are generated with the OpenSSH utility.

    • Private key file: in this field, specify the location of your private key file.

    • Passphrase: in this field, specify your authentication passphrase.

    • Save passphrase: select this checkbox to have PyCharm remember the specified passphrase.

  • 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 macOS and Linux).

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

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.

Last modified: 25 May 2020
CSV FormatsSSH Terminal