PyCharm 2023.3 Help

Connect to a remote server from PyCharm

Since working remotely became a necessity, PyCharm offers the Remote Development functionality to help you code, run, debug, and deploy your projects remotely.

Connection via SSH

The connection to a remote server is done via SSH and can be started right from the welcome screen of PyCharm.

Connect to a remote server and open the remote project

  1. Ensure you have the Remote Development Gateway plugin enabled.

  2. On the PyCharm welcome screen, select Remote Development. Alternatively, go to File | Remote Development in the main menu.

  3. Under SSH Connection, click New Connection.

    If you have the IDE already running on the remote server, and you have a connection link, you can use the Connect to Running IDE section.

  4. Configure the remote server connection parameters and click Check Connection and Continue to make sure the connection to the remote server is successful.

    PyCharm welcome screen
  5. On the next page of the wizard, in the IDE version field, select the source of the remote IDE that you want to use.

    Use one of the following ways to get an IDE installer:

    • Automatically fetch from JetBrains installers storage -default variant.

      Your remote server must have a network connection to JetBrains URLs:

      https://code-with-me.jetbrains.com https://download.jetbrains.com https://download-cf.jetbrains.com https://cache-redirector.jetbrains.com
    • Fetch from your company's internal storage. In this case, you need to click Other options and select Use download link. It is helpful if remote machines don't have an Internet connection to JetBrains' websites or your organization uses some custom builds.

    • Upload from your local machine. In this case, click Other options and select Upload installer file. You need to get the IDE .tar.gz archive from the JetBrains website by yourself in advance.

    PyCharm welcome screen
  6. Click Download and Start IDE.

    PyCharm starts JetBrains Gateway, which downloads the IDE backend, launches, and opens JetBrains Client with your remote project.

For more information about starting to work with a separate JetBrains Gateway installer, refer to JetBrains Gateway.

For more information about adding plugins or SDK, refer to the appropriate Getting Started section.

Connect to a project running on WSL2

You can configure your IDE backend to launch directly in WSL2.

Before you start connecting to WSL, make sure the following prerequisites are met:

  • You have the Windows 10 or 11 version installed on your machine with the Ubuntu 20.04 version installed under WSL2.

  • You have WSL2 configured on your Windows machine. For more information, refer to the WSL2 configuration section.

  • You have at least 200 GB of available space, 8 GB RAM, and 4 CPUs.

  • You use the latest EAP build of JetBrains Gateway.

  • You use the latest EAP version of the backend IDE.

Connect to WSL

  1. Ensure you have the Remote Development Gateway plugin enabled.

  2. On the PyCharm welcome screen, select Remote Development.

  3. Under Remote Development, select WSL.

  4. From the options on the right, click New Connection.

    New Connection
  5. On the next page, select the WSL instance and click Next.

    Choose WSL instance
  6. On the next page, select the IDE version and the project you want open. Click Start IDE and Connect.

    Choose the IDE version and a project

    The connection is established, the backend IDE is downloaded, and the project is opened in JetBrains Client.

JetBrains Gateway is used as an entry point to connect to a remote server via SSH. It launches JetBrains Client, which is a thin client that enables you to work with your remote project.

JetBrains Gateway

You can use one of the following ways to launch JetBrains Gateway:

  • Use PyCharm and the enabled Remote Development Gateway plugin in it. In this case, when you open the PyCharm welcome screen, the Remote Development option will be available immediately and you can connect to your remote server using SSH.

    PyCharm welcome screen
  • Install JetBrains Gateway using the JetBrains Toolbox App.

    Toolbox
  • Manually download and install JetBrains Gateway app.

    Depending on your local OS, use one of the following installers:

    Download the JetBrains Gateway 2021.3 .dmg.

    Download the JetBrains Gateway 2021.3.dmg.

    Download the JetBrains Gateway 2021.3 .exe.

    Download the JetBrains Gateway 2021.3 .tar.gz.

Last modified: 27 December 2023