代码空间中的转发端口

您可以转发代码空间中的端口以测试和调试应用程序。 You can also manage the port protocol and share the port within your organization or publicly.

代码空间可用于使用 GitHub Team 或 GitHub Enterprise Cloud 的组织。 更多信息请参阅“GitHub 的产品”。

关于转发的端口

通过端口转发,您可以访问在代码空间内运行的 TCP 端口。 For example, if you're running a web application on a particular port in your codespace, you can forward that port. This allows you to access the application from the browser on your local machine for testing and debugging.

When an application running inside a codespace prints output to the terminal that contains a localhost URL, such as http://localhost:PORT or http://127.0.0.1:PORT, the port is automatically forwarded. If you're using Codespaces in the browser or in Visual Studio Code, the URL string in the terminal is converted into a link that you can click to view the web page on your local machine. 默认情况下,Codespaces 使用 HTTP 转发端口。

自动端口转发

You can also forward a port manually, label forwarded ports, share forwarded ports with members of your organization, share forwarded ports publicly, and add forwarded ports to the codespace configuration.

转发端口

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

  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡

  2. 在端口列表下,单击 Add port(添加端口)

    添加端口按钮

  3. 键入端口编号或地址,然后按 Enter。

    输入端口按钮的文本框

使用 HTTPS 转发

默认情况下,Codespaces 使用 HTTP 转发端口,但您可以根据需要更新任何端口以使用 HTTPS。

  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡
  2. 右键单击要更新的端口,然后单击 Change Port Protocol(更改端口协议)更改端口协议的选项
  3. 选择此端口所需的协议。 您选择的协议将在代码空间的有效期内被记住用于此端口。
  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡

  2. 在端口列表下,单击 Add port(添加端口)

    添加端口按钮

  3. 键入端口编号或地址,然后按 Enter。

    输入端口按钮的文本框

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

To forward a port use the gh codespace ports forward subcommand. Replace codespace-port:local-port with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed.

gh codespace ports forward codespace-port:local-port

For more information about this command, see the GitHub CLI manual.

To see details of forwarded ports enter gh codespace ports and then choose a codespace.

共享端口

Note: You can only make a port private to an organization if your organization uses GitHub Team or GitHub Enterprise Cloud. This feature is not currently available in the beta version of Codespaces.

If you want to share a forwarded port with others, you can either make the port private to your organization or make the port public. After you make a port private to your organization, anyone in the organization with the port's URL can view the running application. After you make a port public, anyone who knows the URL and port number can view the running application without needing to authenticate.

  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡
  2. Right click the port that you want to share, select the "Port Visibility" menu, then click Private to Organization or Public. Option to select port visibility in right-click menu
  3. 在端口的本地地址右侧,单击复制图标。 端口 URL 的复制图标
  4. 将复制的 URL 发送给您想要与其共享端口的人。
  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡
  2. 右键单击要共享的端口,然后单击 Make Public(公开)右键菜单中公开端口的选项
  3. 在端口的本地地址右侧,单击复制图标。 端口 URL 的复制图标
  4. 将复制的 URL 发送给您想要与其共享端口的人。

To change the visibility of a forwarded port, use the gh codespace ports visibility subcommand. There are three visibility settings:

  • private - Visible only to you. This is the default setting when you forward a port.
  • org - Visible to members of the organization that owns the repository.
  • public - Visible to anyone who knows the URL and port number.

Replace codespace-port with the forwarded port number. Replace setting with private, org, or public. After entering the command choose from the list of codespaces that's displayed.

gh codespace ports visibility codespace-port:setting

You can set the visibility for multiple ports with one command. 例如:

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

For more information about this command, see the GitHub CLI manual.

标记端口

您可以标记端口,使端口更容易在列表中识别。

  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡
  2. 悬停在要标记的端口上,然后单击标签图标。 端口的标签图标
  3. 键入端口的标签,然后按 enter。 输入端口标签的文本框

将端口添加到代码空间配置

您可以将转发的端口添加到仓库的 Codespaces 配置中,因此该端口将自动为创建自仓库的所有代码空间转发。 更新配置后,必须重建任何以前创建的代码空间以应用更改。 更多信息请参阅“为项目配置 Codespaces”。

您可以使用 forwardPorts 属性在 .devcontainer.json 文件中手动配置转发的端口,也可以使用代码空间中的“端口”面板。

  1. 在代码空间中的文本编辑器下,单击“Ports(端口)”。 端口选项卡
  2. 右键单击要添加到代码空间配置的端口,然后单击 Set Label and Update devcontainer.json(设置标签和更新 devcontainer.json)右键菜单中设置标签并将端口添加到 devcontainer.json 的选项
  3. 键入端口的标签,然后按 enter。 输入端口标签的文本框

此文档对您有帮助吗?

隐私政策

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或者, 了解如何参与。