Skip to main content

Restricting the visibility of forwarded ports

You can set constraints on the visibility options users can choose when they forward ports from codespaces in your organization.

To manage access to port visibility constraints for the repositories in an organization, you must be an owner of the organization.

Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. For more information, see "GitHub's products."

Overview

Typically, within a codespace you are able to forward ports privately (only to yourself), to members of your organization, or publicly (to anyone with the URL). For more information, see "Forwarding ports in your codespace."

As an organization owner, you may want to configure constraints on the visibility options users can set when forwarding ports. For example, for security reasons, you may want to disallow public port forwarding. You do this by defining one or more policies in the Codespaces settings for your organization.

Behavior when you set a port visibility constraint

If there are existing codespaces that no longer conform to a policy you have defined, these codespaces will continue to operate until they are stopped or time out. When the user resumes the codespace, it will be subject to the policy constraints.

Note: You can't disable private port forwarding, as private port forwarding is required by Codespaces to continue working as designed, for example to forward SSH on port 22.

Setting organization-wide and repository-specific policies

When you create a policy you choose whether it applies to all repositories in your organization, or only to specified repositories. If you set an organization-wide policy then any policies you set for individual repositories must fall within the restriction set at the organization level. Adding policies makes the choice of visibility options more, not less, restrictive.

For example, you could create an organization-wide policy that restricts the visibility options to organization only. You can then set a policy for Repository A that disallows both public and organization visibility, which would result in only private port forwarding being available for this repository. Setting a policy for Repository A that allowed both public and organization would result in only organization visibility, because the organization-wide policy does not allow public visibility.

If you add an organization-wide policy, you should set it to the most lenient visibility option that will be available for any repository in your organization. You can then add repository-specific policies to further restrict the choice.

Adding a policy to limit the port visibility options

  1. In the top right corner of GitHub.com, click your profile photo, then click Your organizations. Your organizations in the profile menu

  2. Next to the organization, click Settings. The settings button

  3. In the "Code, planning, and automation" section of the sidebar, select Codespaces then click Policies.

  4. On the "Codespace policies" page, click Create Policy.

  5. Enter a name for your new policy.

  6. Click Add constraint and choose Port visibility.

    Add a constraint for port visibility

  7. Click to edit the constraint.

    Edit the port visibility constraint

  8. Clear the selection of the port visibility options (Org or Public) that you don't want to be available.

    Choose the port visibility options

  9. In the "Change policy target" area, click the dropdown button.

  10. Choose either All repositories or Selected repositories to determine which repositories this policy will apply to.

  11. If you chose Selected repositories:

    1. Click .

      Edit the settings for the policy

    2. Select the repositories you want this policy to apply to.

    3. At the bottom of the repository list, click Select repositories.

      Select repositories for this policy

  12. If you want to add another constraint to the policy, click Add constraint and choose another constraint. For information about other constraints, see "Restricting access to machine types" and "Restricting the idle timeout period."

  13. After you have finished adding constraints to your policy, click Save.

Editing a policy

You can edit an existing policy. For example, you may want to add or remove constraints to or from a policy.

  1. Display the "Codespace policies" page. For more information, see "Adding a policy to limit the port visibility options."
  2. Click the name of the policy you want to edit.
  3. Make the required changes then click Save.

Deleting a policy

  1. Display the "Codespace policies" page. For more information, see "Adding a policy to limit the port visibility options."

  2. Click the delete button to the right of the policy you want to delete.

    The delete button for a policy