Weiterleiten von Ports in deinem Codespace

Wenn die Ausgabe einer Anwendung, die in einem Codespace ausgeführt wird, im Terminal angezeigt wird, das eine Localhost-URL wie http://localhost:PORT oder http://127.0.0.1:PORT enthält, wird der Port automatisch weitergeleitet. Wenn du GitHub Codespaces im Browser oder in Visual Studio Code verwendest, wird die URL-Zeichenfolge im Terminal in einen Link konvertiert, auf den du klicken kannst, um die Webseite auf deinem lokalen Computer anzuzeigen. Standardmäßig leitet GitHub Codespaces Ports über HTTP weiter.

Du kannst die Entwicklungscontainerkonfiguration für das Repository bearbeiten, um einen oder mehrere Ports automatisch weiterzuleiten. Du hast die Möglichkeit, einen Port auch manuell weiterzuleiten. Zudem kannst du weitergeleitete Ports bezeichnen, für Mitglieder deiner Organisation oder die Öffentlichkeit freigeben und der Codespacekonfiguration hinzufügen.

Weiterleiten eines Ports

Du kannst einen Port, der nicht automatisch weitergeleitet wurde, manuell weiterleiten.

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS.

3. Klicke unter der Liste der Ports auf Port hinzufügen.

   

4. Gib die Portnummer oder Adresse ein, und drücke die EINGABETASTE.

   

Verwenden der HTTPS-Weiterleitung

GitHub Codespaces leitet Ports standardmäßig mithilfe von HTTP weiter, aber du kannst alle Ports so aktualisieren, dass bei Bedarf das HTTPS verwendet wird. Wenn du einen Port mit öffentlicher Sichtbarkeit zur Verwendung von HTTPS aktualisierst, wird die Sichtbarkeit des Ports automatisch in „privat“ geändert.

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS.

3. Klicke mit der rechten Maustaste auf den Port, den du aktualisieren möchtest. Zeige anschließend auf Portprotokoll ändern.

   

4. Wähle das für diesen Port erforderliche Protokoll aus. Das ausgewählte Protokoll wird für die Lebensdauer des Codespaces für diesen Port gespeichert.

Freigeben eines Ports

Wenn du einen weitergeleiteten Port für andere freigeben möchtest, kannst du den Port entweder als privaten Port für deine Organisation bereitstellen oder ihn öffentlich zugänglich machen. Wenn du einen Port als privaten Port für deine Organisation bereitgestellt hast, kann jeder in der Organisation mit der Port-URL die ausgeführte Anwendung anzeigen. Wenn du einen Port öffentlich zugänglich gemacht hast, kann jeder, der die URL und die Portnummer kennt, die ausgeführte Anwendung ohne Authentifizierung anzeigen.

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS.

3. Klicke mit der rechten Maustaste auf den Port, den du freigeben möchtest. Klicke dann auf das Menü Portsichtbarkeit, und wähle entweder Privat für Organisation oder Öffentlich aus.

   

4. Klicke auf das Kopiersymbol rechts neben der lokalen Adresse für den Port.

   

5. Sende die kopierte URL an die Person, für die du den Port freigeben möchtest.

Verwenden von Befehlszeilentools und REST-Clients für den Zugriff auf Ports

Wenn du einen Port weiterleitest, wird deine Anwendung unter der URL https://CODESPACENAME-PORT.app.github.dev verfügbar. Beispiel: https://monalisa-hot-potato-vrpqrxxrx7x2rxx-4000.app.github.dev. Wenn du einen privaten Port von der VS Code-Desktopanwendung weiterleitest, ist deine Anwendung auch unter einem Localhostport wie 127.0.0.1:4000 verfügbar.

Um über einen REST-Client wie Postman oder ein Befehlszeilentool wie cURL auf deine Anwendung zuzugreifen, musst du dich nicht authentifizieren, wenn du einen Localhostport verwendest oder auf einen öffentlichen Port der Remotedomäne zugreifst. Um jedoch eine Verbindung mit einem privaten Port der Remotedomäne herzustellen, musst du dich authentifizieren, indem du das Zugriffstoken GITHUB_TOKEN in deiner Anforderung angibst.

Ermitteln der Verbindungsadresse

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS. Hier werden alle Ports aufgelistet, die du weitergeleitet hast.

3. Klicke mit der rechten Maustaste auf den Port, mit dem du eine Verbindung herstellen möchtest, und wähle Lokale Adresse kopieren aus.

   

4. Füge die kopierte Adresse irgendwo zur späteren Verwendung ein.

Ermitteln von GITHUB_TOKEN

1. Gib im Terminal deines Codespaces echo $GITHUB_TOKEN ein.

   Das Token ist eine Zeichenfolge, die mit ghu_ beginnt.

2. Kopiere das Token.

   Wichtig: Gib dieses Zugriffstoken an niemanden weiter.

Verwenden von cURL für den Zugriff auf einen weitergeleiteten Port

Gib in einem Terminal auf deinem lokalen Computer Folgendes ein:

curl ADDRESS -H "X-Github-Token: TOKEN"

Ersetze ADDRESS und TOKEN durch die zuvor kopierten Werte.

Verwenden von Postman für den Zugriff auf einen weitergeleiteten Port

1. Öffne Postman.

2. Erstelle eine neue GET-Anforderung.

3. Füge die zuvor kopierte Adresse als Anforderungs-URL ein.

   

4. Erstelle auf der Registerkarte Header einen neuen Eintrag, bei dem der Schlüssel „X-Github-Token“ heißt und der Wert das zuvor kopierte GITHUB_TOKEN ist.

   

5. Klicke auf Senden.

Automatische Weiterleitung eines Ports

Sie können der GitHub Codespaces-Konfiguration für das Repository einen weitergeleiteten Port hinzufügen, sodass der Port automatisch für alle Codespaces weitergeleitet wird, die über das Repository erstellt werden. Nachdem du die Konfiguration aktualisiert hast, müssen alle zuvor erstellten Codespaces neu erstellt werden, damit die Änderung angewendet werden kann. Weitere Informationen zur Konfigurationsdatei für den Entwicklungscontainer findest du unter Einführung in Entwicklungscontainer.

1. Öffnen Sie in Ihrem Codespace die Entwicklungscontainerkonfigurationsdatei, die Sie aktualisieren möchten. In der Regel ist .devcontainer/devcontainer.jsondiese Datei .

2. Hinzufügen der forwardPorts-Eigenschaft.

   "forwardPorts": [NUMBER],
   

   Ersetzen Sie NUMBER durch die Nummer des weitergeleiteten Ports. Dies kann eine durch Trennzeichen getrennte Liste von Portnummern sein.

3. Speicher die Datei.

Bezeichnen eines Ports

Wenn du einen Codespace im Browser oder in der VS Code-Desktopanwendung öffnest, kannst du einen weitergeleiteten Port beschriften, um ihn in einer Liste leichter identifizierbar zu machen.

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS.

3. Klicke mit der rechten Maustaste auf den Port, den du bezeichnen möchtest, und klicke dann auf Portbezeichnung festlegen.

   

4. Gib eine Bezeichnung für deinen Port ein, und drücke dann die EINGABETASTE.

   

Automatisches Bezeichnen eines weitergeleiteten Ports

Du kannst einen Port bezeichnen und die Änderung in eine Entwicklungscontainer-Konfigurationsdatei für das Repository schreiben. Wenn du diesen Schritt für einen Port ausführst, der automatisch mit der forwardPorts-Eigenschaft weitergeleitet wird, wird die Bezeichnung automatisch auf diesen weitergeleiteten Port für alle zukünftigen Codespaces angewendet, die mithilfe dieser Konfigurationsdatei über das Repository erstellt werden.

1. Öffne das Terminal in deinem Codespace.

2. Klicke auf die Registerkarte PORTS.

3. Klicke mit der rechten Maustaste auf den Port, dessen Bezeichnungsattribut du der Codespacekonfiguration hinzufügen möchtest, und klicke dann auf Bezeichnung festlegen und devcontainer.json aktualisieren.

   

4. Gib eine Bezeichnung für deinen Port ein, und drücke dann die EINGABETASTE.

   

5. Wenn dein Repository mehr als eine Entwicklungscontainer-Konfigurationsdatei enthält, wirst du aufgefordert, auszuwählen, welche Datei du aktualisieren möchtest.

   Die Entwicklungscontainer-Konfigurationsdatei wird aktualisiert, um die neue Bezeichnung in die portsAttributes-Eigenschaft einzuschließen. Beispiel:

   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   "forwardPorts": [3333, 4444],
   
   "portsAttributes": {
     "3333": {
       "label": "app-standard-preview"
     },
     "4444": {
       "label": "app-pro-preview"
     }
   }