codespace でのポートの転送

codespace 内で実行されているアプリケーションが、localhost URL (http://localhost:PORT や http://127.0.0.1:PORT など) を含むターミナルに出力すると、ポートが自動的に転送されます。 ブラウザーまたは Visual Studio Code で GitHub Codespaces を使用している場合、ターミナルの URL 文字列はリンクに変換され、それをクリックするとローカル コンピューターで Web ページを表示できます。 既定では、GitHub Codespaces は HTTP を使ってポートを転送します。

リポジトリの開発コンテナー構成を編集して、1 つ以上のポートを自動的に転送できます。 また、ポートの手動転送、転送されるポートへのラベル付け、Organization のメンバーとの転送されるポートの共有、転送されるポートのパブリックな共有、codespace の構成への転送されるポートの追加などを行うこともできます。

ポートの転送

自動的に転送されなかったポートを手動で転送できます。

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。

3. ポートの一覧で、 [ポートの追加] をクリックします。

   

4. ポート番号またはアドレスを入力し、Enter キーを押します。

   

HTTPS 転送の使用

既定では、GitHub Codespaces は HTTP を使ってポートを転送しますが、必要に応じて、HTTPS を使うように任意のポートを更新できます。 パブリック表示を使ってポートを HTTPS を使えるように更新すると、ポートの表示は自動的にプライベートに変更されます。

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。

3. 更新するポートを右クリックし、 [ポートのプロトコルの変更] をポイントします。

   

4. このポートに必要なプロトコルを選択します。 選択したプロトコルは、codespace の有効期間中、このポートに対して記憶されます。

ポートの共有

転送されるポートを他のユーザーと共有する場合は、ポートを Organization に対してプライベートにするか、ポートをパブリックにすることができます。 ポートを Organization に対してプライベートにすると、そのポートの URL がわかっている組織内のすべてのユーザーが、実行中のアプリケーションを表示できます。 ポートをパブリックにすると、URL とポート番号を知っているすべてのユーザーが、認証を必要とせずに、実行中のアプリケーションを表示できます。

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。

3. 共有するポートを右クリックし、 [ポートの可視性] をクリックしてから、 [Organization にプライベート] または [パブリック] をクリックします。

   

4. ポートのローカル アドレスの右側にあるコピー アイコンをクリックします。

   

5. コピーした URL を、ポートを共有するユーザーに送信します。

コマンド ライン ツールと REST クライアントを使用してポートにアクセスする

ポートを転送すると、URL https://CODESPACENAME-PORT.app.github.dev でアプリケーションを使えるようになります。 たとえば、https://monalisa-hot-potato-vrpqrxxrx7x2rxx-4000.app.github.dev のようにします。 VS Code デスクトップ アプリケーションからプライベート ポートを転送した場合、アプリケーションは 127.0.0.1:4000 のような localhost ポートでも使えるようになります。

Postman などの REST クライアントや curl などのコマンド ライン ツールを使ってアプリケーションにアクセスするとき、localhost ポートを使っている場合、またはリモート ドメインのパブリック ポートにアクセスしている場合は、認証を行う必要はありません。 ただし、リモート ドメインでプライベート ポートに接続するには、要求で GITHUB_TOKEN アクセス トークンを使って認証を行う必要があります。

接続先のアドレスを見つける

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。これにより、転送したすべてのポートの一覧が表示されます。

3. 接続するポートを右クリックし、 [ローカル アドレスのコピー] をクリックします。

   

4. 後で使うため、コピーしたアドレスをどこかに貼り付けます。

GITHUB_TOKEN を見つける

1. codespace のターミナルで、「echo $GITHUB_TOKEN」と入力します。

   トークンは、ghu_ で始まる文字列です。

2. トークンをコピーします。

   Important

   このアクセス トークンを誰とも共有しないでください。

curl を使用して転送されたポートにアクセスする

ローカル コンピューターのターミナルで、次のように入力します。

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

ADDRESS と TOKEN は、前にコピーした値に置き換えます。

Postman を使用して転送されたポートにアクセスする

1. Postman を開きます。

2. 新しい GET 要求を作成します。

3. 前にコピーしたアドレスを要求 URL として貼り付けます。

   

4. [ヘッダー] タブで、キーとして "X-Github-Token"、値として前にコピーした GITHUB_TOKEN を指定して、新しいエントリを作成します。

   

5. [送信] をクリックします。

ポートの自動転送

転送されるポートをリポジトリの GitHub Codespaces 構成に追加すると、リポジトリから作成されるすべての codespace でポートが自動的に転送されるようにすることができます。 変更を適用するには、構成を更新した後、以前に作成した codespace をリビルドする必要があります。 開発コンテナーの構成ファイルについて詳しくは、「開発コンテナーの概要」をご覧ください。

1. codespace で、更新する開発コンテナー構成ファイルを開きます。 通常、このファイルは .devcontainer/devcontainer.json です。

2. forwardPorts プロパティを追加します。

   "forwardPorts": [NUMBER],
   

   NUMBER を、転送するポート番号に置き換えます。 これを、ポート番号のコンマ区切りのリストにすることができます。

3. ファイルを保存します。

ポートのラベル付け

ブラウザーまたは VS Code デスクトップ アプリケーションで codespace を開くと、転送されたポートにラベルを付けて、リストで識別しやすくすることができます。

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。

3. ラベル付けするポートを右クリックし、[ポート ラベルの設定] をクリックします。

   

4. ポートのラベルを入力して、Enter キーを押します。

   

転送されたポートに自動的にラベルを付ける

ポートにラベルを付け、リポジトリの開発コンテナー構成ファイルに変更を書き込むことができます。 forwardPorts プロパティを使用して、自動的に転送されるポートに対してこれを行うと、その構成ファイルを使用してリポジトリから作成されるすべての将来の codespace で、その転送されたポートにラベルが自動的に適用されます。

1. codespace でターミナルを開きます。

2. [ポート] タブをクリックします。

3. codespace の構成に追加するラベル属性のポートを右クリックして、[ラベルを設定して devcontainer.json を更新する] をクリックします。

   

4. ポートのラベルを入力して、Enter キーを押します。

   

5. リポジトリに複数の開発コンテナー構成ファイルがある場合は、更新するファイルを選ぶように求められます。

   portsAttributes プロパティに新しいラベルが含まれるように開発コンテナー構成ファイルが更新されます。 次に例を示します。

   // 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"
     }
   }