Zum Hauptinhalt springen
Version: Weekly Build

Verbindung zum Workspace über SSH herstellen

Diese Anleitung führt durch die Einrichtung des Secure Shell (SSH)-Zugriffs für Workspaces. Damit lässt sich sicher eine Verbindung zur Entwicklungsumgebung herstellen und direkt über das lokale Terminal mit ihr arbeiten.

Voraussetzungen​

Bevor eine Verbindung hergestellt werden kann, muss ein SSH-Schlüsselpaar auf dem lokalen Rechner generiert sein. Falls noch keines vorhanden ist, im lokalen Terminal Folgendes ausführen:
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)​

Einen neuen öffentlichen Schlüssel registrieren​

Voraussetzungen​

  • Ein gültiges Public API Token zur Authentifizierung der Anfragen für die Schlüsselverwaltung. Details siehe 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 als Zeichenfolge in das Feld publicKey einfügen.

  • Endpunkt: POST https://<YOUR_DOMAIN>/api/ssh/keys
  • Header:
    • 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 aktuell für den Zugriff auf die Workspaces autorisiert sind, eine GET-Anfrage senden:

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

Einen SSH-Schlüssel entfernen​

Um den Zugriff für einen bestimmten Schlüssel zu widerrufen, 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 die Verbindungszeichenfolge des Workspaces direkt auf der Plattform finden.

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

Menüoption „Connect via SSH“ Kopieren der Verbindungszeichenfolge aus dem Workspace.

Beispielbefehl:​

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

Die Rechenzentrums-ID (Data Center ID) ist in den Team-Einstellungen zu finden (nur für Administratoren).

Verbindung von einer lokalen IDE aus herstellen​

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