JetBrains Rider
 
2023.1
Shortcuts: Visual Studio 2022 (Windows)
Get JetBrains Rider
You are viewing the documentation for an earlier version of JetBrains Rider.
  1. Run, debug, test, deploy
  2. Debugging
  3. Debug remote applications via SSH

Debug remote applications via SSH

Last modified: 17 April 2023

In this tutorial we'll see how to use an SSH tunnel to set up a secure connection between the development machine and a remote host to debug your web application running there.

Set up SSH server on the remote host

Depending on the operating system that the remote host runs, configure SSH access to it.

Install and configure JetBrains SSH server for remote debugging — it will quickly and securely start SSH on a remote host and generate access credentials that you can use to access the host.

  1. Download the JetBrains SSH server executable for 32-bit Windows or for 64-bit Windows.

  2. Run the executable. Optionally, you can specify the desired port with the -port argument (for example, jetbrains_debugger_agent_20230319.24.0 -port=1234) otherwise the port will be randomly selected.

  3. The SSH will start, and you will see the access credentials (Login, Password, and Port) in the output.

  4. Make sure that the port is accessible:

    • either both the development machine and the remote host should be in the same network,

    • or the firewall/port-forwarding should be configured so that the port is accessible from outside the network

Alternatively, you can install and configure OpenSSH For Windows.

Create a web application

If you have a web application, you can go on with it. Otherwise, you can create a sample ASP .NET MVC application — choose File | New from the main menu and use the New Solution wizard:

Creating a new ASP.NET MVC application

Configure connections to the remote host

The connection to the remote host will be used by two subsystems — first, to deploy the application remotely via SFTP and second, to establish a remote debugging session via SSH.

Deploy the application to the remote host

To deploy applications with JetBrains Rider, you need to create and use run configurations.

Now you will be able to publish your application to the remote host as soon as your application is ready or each time it is modified. As we used a boilerplate project template for the web application, it is ready to be published:

SSH remote debugging. Deployment run

When the application is deployed, we can run it on the remote host.

Debug the application on the remote host

As soon as the application execution reaches the breakpoint, it will stop, and you will be able to debug it:

SSH remote debugging. Debugging the application

Optional deployment of remote debug tools

When the debugger connects to a remote host where the target application runs, it relies on the remote debug tools (dotnet executables, Rider agents, and their dependencies) that must be deployed on the remote host.

If there are no remote debug tools found, the debugger will silently deploy them when it connects to the application for the first time.

However, there are scenarios when the target environment is updated on each connection, for example if you debug an application inside a Docker container and the whole Docker image is rebuilt when you rebuild the application.

In such cases, each new debugging session has to start by deploying the remote debug tools, which may be slow.

To avoid this startup delay, you can manually or automatically deploy the remote debugging tools on the target host before connecting with the debugger.

  1. Download the remote debug tools for Windows using one of the following links:

  2. Unzip the tools to the RiderRemoteDebugger directory on the target machine or Docker image. For example %LOCALAPPDATA%\JetBrains\RiderRemoteDebugger\2022.1.1

See also

External Links