Zum Hauptinhalt springen
Version: Weekly Build

Verbindung zum Workspace über SSH herstellen

Diese Anleitung führt durch die Einrichtung des Secure-Shell-Zugriffs (SSH) für den Workspace. Damit lässt sich sicher direkt vom lokalen Terminal aus mit der Entwicklungsumgebung verbinden und interagieren.

Voraussetzungen​

Bevor eine Verbindung hergestellt werden kann, muss auf dem lokalen Rechner ein SSH-Schlüsselpaar vorhanden sein. Falls noch keines erstellt wurde, kann im lokalen Terminal folgender Befehl ausgeführt werden:
ssh-keygen -t ed25519 -C "[email protected]"

SSH-Schlüssel hinzufügen (über die UI)​

Zu User Settings > SSH Keys navigieren und auf Add SSH Key klicken, um den öffentlichen Schlüssel hinzuzufügen oder hochzuladen.

Menüoption „Connect via SSH“ Hinzufügen eines öffentlichen SSH-Schlüssels in der UI.

Alternative: SSH-Schlüssel hinzufügen (über die Public API)​

Neuen öffentlichen Schlüssel registrieren​

Voraussetzungen​

  • Ein gültiges Public API Token, um die Anfragen zur Schlüsselverwaltung zu authentifizieren. Details dazu in der Public-API-Dokumentation.

Eine POST-Anfrage senden, um den öffentlichen Schlüssel hochzuladen. <YOUR_API_TOKEN> durch das eigene Authentifizierungstoken ersetzen und den öffentlichen Schlüssel-String in das Feld publicKey einfügen.

  • Endpunkt: POST https://<YOUR_DOMAIN>/api/ssh/keys
  • Headers:
    • Authorization: Bearer <YOUR_API_TOKEN>
    • Content-Type: application/json
curl -X POST https://<YOUR_DOMAIN>/api/ssh/keys \
 -H "Authorization: Bearer <YOUR API TOKEN>" \
 -H "Content-Type: application/json" \
 -d '{  "publicKey": "<YOUR PUBLIC KEY>"  }'

Registrierte Schlüssel anzeigen​

Um eine Liste aller öffentlichen Schlüssel anzuzeigen, die derzeit für den Zugriff auf den Workspace autorisiert sind, eine GET-Anfrage senden:

curl -X GET https://<YOUR_DOMAIN>.com/api/ssh/keys \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"

SSH-Schlüssel entfernen​

Falls der Zugriff für einen bestimmten Schlüssel widerrufen werden soll, eine DELETE-Anfrage senden:

curl -X DELETE https://<YOUR_DOMAIN>.com/api/ssh/keys \
  -H "Authorization: Bearer <YOUR API TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "publicKeyFingerprint": "<YOUR PUBLIC KEY FINGERPRINT>"
  }'

Verbindung zum Workspace herstellen​

Sobald der öffentliche Schlüssel registriert ist, lässt sich der Verbindungsstring für den Workspace direkt in der Plattform finden.

  1. Den aktiven Workspace öffnen.
  2. Auf das Editor-Dropdown in der oberen rechten Toolbar klicken.
  3. Connect via SSH auswählen.
  4. Den Verbindungsstring aus dem Modal kopieren und in das lokale Terminal einfügen.

Menüoption „Connect via SSH“ Kopieren des Verbindungsstrings aus dem Workspace.

Beispielbefehl:

ssh -J <dcId>.ssh.<your_domain> user@<workspaceId>

Die Data-Center-ID findet sich in den Team-Einstellungen (nur für Admins).

Verbindung von einer lokalen IDE aus​

Für die Einrichtung der SSH-Remote-Entwicklung die offizielle Dokumentation der jeweiligen IDE konsultieren: