Visual Studio Code mit einem Remote-Server verbinden

Microsofts Editor Visual Studio Code kann nicht nur für die Arbeit an lokalen Projekten eingesetzt werden. Vielmehr ist es möglich per SSH auf Remote-Server zuzugreifen. Voraussetzung dafür ist die Installation von Microsofts Remote – SSH Erweiterung.

Diese Erweiterung ist Bestandteil des Erweiterungspakets Remote Development, das neben Remote – SSH auch die Erweiterungen Remote Containers und Remote WSL enthält. Das Erweiterungspaket solltet Ihr also installieren, wenn Ihr nicht nur auf einen Remote-Server zugreifen möchtet, sondern zusätzlich eine Unterstützung für den Zugriff auf Docker-Container oder das Windows Subsystem für Linux benötigt.

OpenSSH installieren

Damit die Erweiterung Remote – SSH genutzt werden kann, wird auf Eurem System ein OpenSSH kompatibler SSH-Client benötigt:

BetriebssystemInstallation
macOSbereits vorinstalliert
Windows 10 1803 oder neuerOpenSSH gemäß dieser Anleitung installieren
Debian-basierte Linux-Systeme$ sudo apt-get install openssh-client
RedHat-basierte Linux-Systeme$ sudo yum install openssh-clients

Sind alle Voraussetzungen erfüllt, kann es auch schon losgehen. Bevor eine Verbindung über Visual Studio Code hergestellt wird, solltet Ihr sichergehen, dass die SSH-Verbindung zum Remote-Server überhaupt funktioniert. Gebt dazu in einer Shell

ssh <Benutzername>@<Remote-Server>

ein.

SSH-Zugriff in Visual Studio Code einrichten

In Visual Studio Code öffnet Ihr zunächst die Befehlspalette. Dazu wählt Ihr

> Anzeigen > Befehlspalette

aus oder verwendet die Tastenkombination

Shift + command + P // <- macOS
Shift + Strg + P // <- Windows, Linux

Dort ist dann

Remote-SSH: Connect to Host...

auszuwählen, wobei Ihr eine Übersicht der zur Verfügung stehenden Optionen sehen solltet, sobald Ihr „Remote-SSH“ eingegeben habt.

Connect to Host in Visual Studio Code

Das führt zu einem Eingabefeld, in dem der Befehl ssh zusammen mit dem Benutzername und dem Hostnamen in der Form

ssh <Benutzername>@<Remote-Server>

einzugeben sind. Es erscheint dann die Aufforderung diese SSH-Konfiguration zu speichern. Die dabei angezeigte Auswahl kann einfach übernommen werden. Unter macOS führt dies dazu, dass die Konfiguration (Benutzername und Host) unter

/Users/Benutzername/.ssh/config

gespeichert werden.

Unten rechts erscheint anschließend der Hinweis, dass ein neuer Host hinzugefügt wurde.

Connect to Host in Visual Studio Code

Ab diesem Zeitpunkt kann der so hinzugefügte Remote-Server über die Befehlspalette nach der Auswahl von

Remote-SSH: Connect to Host...

ausgewählt (und eine Verbindung hergestellt) werden.

Sobald eine Verbindung zum Remote-Server aufgebaut wurde, führt ein Klick auf „Ordner öffnen“ dazu, dass jetzt das Dateisystem des Remote-Servers angezeigt wird. Außerdem erscheint im Terminalfenster die Shell des Remote-Servers.

Unten links seht Ihr außerdem den Hinweis, dass eine SSH-Verbindung besteht. Ihr könnt diesen Hinweis anklicken und dann die Verbindung mit der Auswahl von „Remoteverbindung schließen“ beenden.

Terminal View in Visual Studio Code