在您的 Codespace 中转发端口

您可以转发 Codespace 中的端口以测试和调试您的应用程序。您还可以管理端口协议，并在您的组织内或公开共享端口。

本文内容

注意

  • 目前，使用 JetBrains IDE 与 GitHub Codespaces 集成处于公开预览阶段，可能会发生更改。
  • 要在 JetBrains IDE 中处理 Codespace，您必须使用 JetBrains Gateway 的 2023.3.* 或 2024.1.* 版本。

关于转发端口

端口转发使您可以访问在 Codespace 中运行的 TCP 端口。例如，如果您在 Codespace 中的特定端口上运行 Web 应用程序，则可以转发该端口。这使您可以从本地计算机上的浏览器访问该应用程序以进行测试和调试。

当在 Codespace 中运行的应用程序将包含 localhost URL（例如https://127.0.0.1:PORT 或http://127.0.0.1:PORT）的输出打印到终端时，端口会自动转发。如果您在浏览器或 Visual Studio Code 中使用 GitHub Codespaces，则终端中的 URL 字符串将转换为链接，您可以点击该链接以在本地计算机上查看网页。默认情况下，GitHub Codespaces 使用 HTTP 转发端口。

您可以编辑仓库的开发容器配置来自动转发一个或多个端口。您还可以手动转发端口、标记已转发端口、与组织成员共享已转发端口、公开共享已转发端口以及将已转发端口添加到 Codespace 配置。

注意

组织所有者可以限制公开或在组织内提供转发端口的功能。有关更多信息，请参阅“限制转发端口的可见性”。

转发端口

您可以手动转发未自动转发的端口。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 在端口列表下，点击添加端口。

    Screenshot of the "Add port" button.

  4. 键入端口号或地址，然后按 Enter。

    Screenshot of the number 3000 being entered into the port number field for a new forwarded port.

使用 HTTPS 转发

默认情况下，GitHub Codespaces 使用 HTTP 转发端口，但您可以根据需要更新任何端口以使用 HTTPS。如果您更新具有公共可见性的端口以使用 HTTPS，则该端口的可见性将自动更改为私有。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要更新的端口，然后将鼠标悬停在更改端口协议上。

    Screenshot of the pop-up menu for a forwarded port, with the "Change Port Protocol" option selected and "HTTPS" selected in the submenu.

  4. 选择此端口所需的协议。您选择的协议将在此 Codespace 的生命周期内为此端口记住。

共享端口

注意

只有当您的组织使用 GitHub Team 或 GitHub Enterprise Cloud 时，您才能将端口设为仅组织内部私有。

如果您想与他人共享已转发的端口，您可以将其设为仅组织内部私有，或将其设为公开。将端口设为仅组织内部私有后，组织中拥有该端口 URL 的任何人都可以查看正在运行的应用程序。将其设为公开后，任何知道 URL 和端口号的人都可以查看正在运行的应用程序，无需进行身份验证。

注意

您的端口可见性选项的选择可能会受到为您的组织配置的策略的限制。有关更多信息，请参阅“限制转发端口的可见性”。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要共享的端口，点击端口可见性，然后点击仅限组织内部私有或公开。

    Screenshot of the pop-up menu for a forwarded port, with the "Port Visibility" option selected and "Private" selected in the submenu.

  4. 在端口的本地地址右侧，点击复制图标。

    Screenshot of the "Ports" panel. The copy icon, which copies a forwarded port's URL, is highlighted with an orange outline.

  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）上可用。

要使用 REST 客户端（例如 Postman）或命令行工具（例如 curl）访问您的应用程序，如果您使用的是本地端口，或者如果您正在访问远程域上的公共端口，则无需进行身份验证。但是，要连接到远程域上的私有端口，您必须使用请求中的GITHUB_TOKEN 访问令牌进行身份验证。

注意

GITHUB_TOKEN 在您启动 Codespace 时自动创建，并在 Codespace 会话期间保持不变。如果您停止然后重新启动 Codespace，则会生成新的GITHUB_TOKEN。

查找要连接的地址

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。这将列出您已转发的所有端口。

  3. 右键点击您要连接的端口，然后点击复制本地地址。

    Screenshot of the pop-up menu for a forwarded port with the "Copy Local Address" option highlighted with an orange outline.

  4. 将复制的地址粘贴到某个位置以备后用。

查找 GITHUB_TOKEN

  1. 在 Codespace 的终端中，输入echo $GITHUB_TOKEN。

    该令牌是以ghu_开头的字符串。

  2. 复制令牌。

    重要

    不要与任何人共享此访问令牌。

使用 curl 访问已转发的端口

在您本地计算机的终端中，输入

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

将ADDRESS 和TOKEN 替换为您之前复制的值。

使用 Postman 访问已转发的端口

  1. 打开 Postman。

  2. 创建一个新的 GET 请求。

  3. 将您之前复制的地址粘贴为请求 URL。

    Screenshot of the URL for the forwarded port, pasted into Postman as the GET request URL. The URL is highlighted.

  4. 在标头选项卡中，创建一个新的条目，其中键为“X-Github-Token”，值为之前复制的GITHUB_TOKEN。

    Screenshot of a dummy GITHUB_TOKEN, pasted into Postman as the value of the X-GitHub-Token key. The key and value are highlighted.

  5. 点击发送。

自动转发端口

您可以将已转发的端口添加到仓库的 GitHub Codespaces 配置中，以便为从仓库创建的所有 Codespaces 自动转发该端口。更新配置后，必须重建任何先前创建的 Codespaces 才能应用更改。有关开发容器配置文件的更多信息，请参阅“开发容器简介”。

  1. 在您的 Codespace 中，打开您要更新的开发容器配置文件。通常，此文件为.devcontainer/devcontainer.json。

  2. 添加forwardPorts 属性。

    "forwardPorts": [NUMBER],

    将NUMBER 替换为您要转发的端口号。这可以是端口号的逗号分隔列表。

  3. 保存文件。

标记端口

当您在浏览器或 VS Code 桌面应用程序中打开 Codespace 时，您可以标记已转发的端口，以便在列表中更容易识别。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要标记的端口，然后点击设置端口标签。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Port Label" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

自动标记已转发的端口

您可以标记端口并将更改写入仓库的开发容器配置文件。如果您对使用forwardPorts 属性自动转发的端口执行此操作，则该标签将自动应用于使用该配置文件从仓库创建的所有未来 Codespaces 的已转发端口。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要将其标签属性添加到 Codespace 配置的端口，然后点击设置标签并更新 devcontainer.json。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Label and Update devcontainer.json" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

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

当在 Codespace 中运行的应用程序将包含 localhost URL（例如https://127.0.0.1:PORT 或http://127.0.0.1:PORT）的输出打印到终端时，端口会自动转发。如果您在浏览器或 Visual Studio Code 中使用 GitHub Codespaces，则终端中的 URL 字符串将转换为链接，您可以点击该链接以在本地计算机上查看网页。默认情况下，GitHub Codespaces 使用 HTTP 转发端口。

您可以编辑仓库的开发容器配置来自动转发一个或多个端口。您还可以手动转发端口、标记已转发端口、与组织成员共享已转发端口、公开共享已转发端口以及将已转发端口添加到 Codespace 配置。

注意

组织所有者可以限制公开或在组织内提供转发端口的功能。有关更多信息，请参阅“限制转发端口的可见性”。

转发端口

您可以手动转发未自动转发的端口。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 在端口列表下，点击添加端口。

    Screenshot of the "Add port" button.

  4. 键入端口号或地址，然后按 Enter。

    Screenshot of the number 3000 being entered into the port number field for a new forwarded port.

共享端口

注意

只有当您的组织使用 GitHub Team 或 GitHub Enterprise Cloud 时，您才能将端口设为仅组织内部私有。

如果您想与他人共享已转发的端口，您可以将其设为仅组织内部私有，或将其设为公开。将端口设为仅组织内部私有后，组织中拥有该端口 URL 的任何人都可以查看正在运行的应用程序。将其设为公开后，任何知道 URL 和端口号的人都可以查看正在运行的应用程序，无需进行身份验证。

注意

您的端口可见性选项的选择可能会受到为您的组织配置的策略的限制。有关更多信息，请参阅“限制转发端口的可见性”。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要共享的端口，点击端口可见性，然后点击仅限组织内部私有或公开。

    Screenshot of the pop-up menu for a forwarded port, with the "Port Visibility" option selected and "Private" selected in the submenu.

  4. 在端口的本地地址右侧，点击复制图标。

    Screenshot of the "Ports" panel. The copy icon, which copies a forwarded port's URL, is highlighted with an orange outline.

  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）上可用。

要使用 REST 客户端（例如 Postman）或命令行工具（例如 curl）访问您的应用程序，如果您使用的是本地端口，或者如果您正在访问远程域上的公共端口，则无需进行身份验证。但是，要连接到远程域上的私有端口，您必须使用请求中的GITHUB_TOKEN 访问令牌进行身份验证。

注意

GITHUB_TOKEN 在您启动 Codespace 时自动创建，并在 Codespace 会话期间保持不变。如果您停止然后重新启动 Codespace，则会生成新的GITHUB_TOKEN。

查找要连接的地址

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。这将列出您已转发的所有端口。

  3. 右键点击您要连接的端口，然后点击复制本地地址。

    Screenshot of the pop-up menu for a forwarded port with the "Copy Local Address" option highlighted with an orange outline.

  4. 将复制的地址粘贴到某个位置以备后用。

查找 GITHUB_TOKEN

  1. 在 Codespace 的终端中，输入echo $GITHUB_TOKEN。

    该令牌是以ghu_开头的字符串。

  2. 复制令牌。

    重要

    不要与任何人共享此访问令牌。

使用 curl 访问已转发的端口

在您本地计算机的终端中，输入

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

将ADDRESS 和TOKEN 替换为您之前复制的值。

使用 Postman 访问已转发的端口

  1. 打开 Postman。

  2. 创建一个新的 GET 请求。

  3. 将您之前复制的地址粘贴为请求 URL。

    Screenshot of the URL for the forwarded port, pasted into Postman as the GET request URL. The URL is highlighted.

  4. 在标头选项卡中，创建一个新的条目，其中键为“X-Github-Token”，值为之前复制的GITHUB_TOKEN。

    Screenshot of a dummy GITHUB_TOKEN, pasted into Postman as the value of the X-GitHub-Token key. The key and value are highlighted.

  5. 点击发送。

自动转发端口

您可以将已转发的端口添加到仓库的 GitHub Codespaces 配置中，以便为从仓库创建的所有 Codespaces 自动转发该端口。更新配置后，必须重建任何先前创建的 Codespaces 才能应用更改。有关开发容器配置文件的更多信息，请参阅“开发容器简介”。

  1. 在您的 Codespace 中，打开您要更新的开发容器配置文件。通常，此文件为.devcontainer/devcontainer.json。

  2. 添加forwardPorts 属性。

    "forwardPorts": [NUMBER],

    将NUMBER 替换为您要转发的端口号。这可以是端口号的逗号分隔列表。

  3. 保存文件。

标记端口

当您在浏览器或 VS Code 桌面应用程序中打开 Codespace 时，您可以标记已转发的端口，以便在列表中更容易识别。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要标记的端口，然后点击设置端口标签。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Port Label" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

自动标记已转发的端口

您可以标记端口并将更改写入仓库的开发容器配置文件。如果您对使用forwardPorts 属性自动转发的端口执行此操作，则该标签将自动应用于使用该配置文件从仓库创建的所有未来 Codespaces 的已转发端口。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要将其标签属性添加到 Codespace 配置的端口，然后点击设置标签并更新 devcontainer.json。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Label and Update devcontainer.json" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

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

要了解有关 GitHub CLI 的更多信息，请参阅“关于 GitHub CLI”。

要转发端口，请使用gh codespace ports forward 子命令。将codespace-port:local-port 替换为您要连接的远程和本地端口。输入命令后，从显示的 Codespace 列表中选择。

gh codespace ports forward CODESPACE-PORT:LOCAL-PORT

有关此命令的更多信息，请参阅GitHub CLI 手册。

要查看已转发端口的详细信息，请输入gh codespace ports，然后选择一个 Codespace。

共享端口

注意

只有当您的组织使用 GitHub Team 或 GitHub Enterprise Cloud 时，您才能将端口设为仅组织内部私有。

如果您想与他人共享已转发的端口，您可以将其设为仅组织内部私有，或将其设为公开。将端口设为仅组织内部私有后，组织中拥有该端口 URL 的任何人都可以查看正在运行的应用程序。将其设为公开后，任何知道 URL 和端口号的人都可以查看正在运行的应用程序，无需进行身份验证。

注意

您的端口可见性选项的选择可能会受到为您的组织配置的策略的限制。有关更多信息，请参阅“限制转发端口的可见性”。

要更改已转发端口的可见性，请使用gh codespace ports visibility 子命令。共有三个可见性设置

  • private - 仅您可见。这是转发端口时的默认设置。
  • org - 拥有仓库的组织的成员可见。
  • public - 任何知道 URL 和端口号的人可见。

将codespace-port 替换为已转发的端口号。将setting 替换为private、org 或public。输入命令后，从显示的 Codespace 列表中选择。

gh codespace ports visibility CODESPACE-PORT:SETTINGS

您可以使用一个命令为多个端口设置可见性。例如

gh codespace ports visibility 80:private 3000:public 3306:org

有关此命令的更多信息，请参阅GitHub CLI 手册。

使用命令行工具和 REST 客户端访问端口

转发端口后，您的应用程序将可在 URL https://CODESPACENAME-PORT.app.github.dev 上访问。例如，https://monalisa-hot-potato-vrpqrxxrx7x2rxx-4000.app.github.dev。如果您从 VS Code 桌面应用程序转发私有端口，则您的应用程序还将在本地端口（例如127.0.0.1:4000）上可用。

要使用 REST 客户端（例如 Postman）或命令行工具（例如 curl）访问您的应用程序，如果您使用的是本地端口，或者如果您正在访问远程域上的公共端口，则无需进行身份验证。但是，要连接到远程域上的私有端口，您必须使用请求中的GITHUB_TOKEN 访问令牌进行身份验证。

注意

GITHUB_TOKEN 在您启动 Codespace 时自动创建，并在 Codespace 会话期间保持不变。如果您停止然后重新启动 Codespace，则会生成新的GITHUB_TOKEN。

查找要连接的地址

要查找已转发端口的地址，请输入gh codespace ports。如果您有多个 Codespace，请从显示的列表中选择相应的 Codespace。

复制地址并将其粘贴到某个位置以备后用。

查找 GITHUB_TOKEN

  1. 为您的 Codespace 启动 SSH 会话。

    gh codespace ssh

  2. 如果您有多个 Codespace，请从显示的列表中选择相应的 Codespace。

  3. 显示GITHUB_TOKEN。

    echo $GITHUB_TOKEN

    该令牌是以ghu_开头的字符串。

  4. 复制令牌。

    重要

    不要与任何人共享此访问令牌。

  5. 退出 SSH 会话。

    exit

使用 curl 访问已转发的端口

在您本地计算机的终端中，输入

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

将ADDRESS 和TOKEN 替换为您之前复制的值。

使用 Postman 访问已转发的端口

  1. 打开 Postman。

  2. 创建一个新的 GET 请求。

  3. 将您之前复制的地址粘贴为请求 URL。

    Screenshot of the URL for the forwarded port, pasted into Postman as the GET request URL. The URL is highlighted.

  4. 在标头选项卡中，创建一个新的条目，其中键为“X-Github-Token”，值为之前复制的GITHUB_TOKEN。

    Screenshot of a dummy GITHUB_TOKEN, pasted into Postman as the value of the X-GitHub-Token key. The key and value are highlighted.

  5. 点击发送。

自动转发端口

您可以将已转发的端口添加到仓库的 GitHub Codespaces 配置中，以便为从仓库创建的所有 Codespaces 自动转发该端口。更新配置后，必须重建任何先前创建的 Codespaces 才能应用更改。有关开发容器配置文件的更多信息，请参阅“开发容器简介”。

  1. 在您的 Codespace 中，打开您要更新的开发容器配置文件。通常，此文件为.devcontainer/devcontainer.json。

  2. 添加forwardPorts 属性。

    "forwardPorts": [NUMBER],

    将NUMBER 替换为您要转发的端口号。这可以是端口号的逗号分隔列表。

  3. 保存文件。

标记端口

当您在浏览器或 VS Code 桌面应用程序中打开 Codespace 时，您可以标记已转发的端口，以便在列表中更容易识别。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要标记的端口，然后点击设置端口标签。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Port Label" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

自动标记已转发的端口

您可以标记端口并将更改写入仓库的开发容器配置文件。如果您对使用forwardPorts 属性自动转发的端口执行此操作，则该标签将自动应用于使用该配置文件从仓库创建的所有未来 Codespaces 的已转发端口。

  1. 在您的 Codespace 中打开终端。

  2. 点击端口选项卡。

  3. 右键点击您要将其标签属性添加到 Codespace 配置的端口，然后点击设置标签并更新 devcontainer.json。

    Screenshot of the pop-up menu for a forwarded port, with the "Set Label and Update devcontainer.json" option highlighted with an orange outline.

  4. 键入端口的标签，然后按 Enter。

    Screenshot of the label "Staging" added as a custom label for a forwarded port.

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

在命令行上查看端口标签

列出 Codespace 的已转发端口时，您可以查看端口标签。为此，请使用gh codespace ports 命令，然后选择一个 Codespace。

转发端口

有关如何在 Codespace 中将端口转发到本地计算机上的端口的信息，请参阅 JetBrains 文档中“安全模型”文章的“端口转发”部分。

或者，您可以使用 GitHub CLI 转发端口。有关更多信息，请点击此页面顶部的“GitHub CLI”选项卡。