Skip to main content

Restricting the idle timeout period

You can set a maximum timeout period for any codespaces owned by your organization.

Who can use this feature

To manage timeout constraints for an organization's codespaces, you must be an owner of the organization.

Overview

By default, codespaces time out after 30 minutes of inactivity. When a codespace times out it is stopped and will no longer incur charges for compute usage.

The personal settings of a GitHub user allow them to define their own timeout period for codespaces they create. This may be longer than the default 30-minute period. For more information, see "Setting your timeout period for GitHub Codespaces."

As an organization owner, you may want to configure constraints on the maximum idle timeout period for codespaces created for repositories owned by your organization. This can help you to limit costs associated with codespaces that are left to timeout after long periods of inactivity. You can set a maximum timeout for the codespaces for all repositories owned by your organization, or for the codespaces of specific repositories.

Note: Maximum idle timeout constraints only apply to codespaces that are owned by your organization.

For more information about pricing for GitHub Codespaces compute usage, see "About billing for GitHub Codespaces."

Behavior when you set a maximum idle timeout constraint

If someone sets the default idle timeout to 90 minutes in their personal settings and they then start a codespace for a repository with a maximum idle timeout constraint of 60 minutes, the codespace will time out after 60 minutes of inactivity. When codespace creation completes, a message explaining this will be displayed:

Idle timeout for this codespace is set to 60 minutes in compliance with your organization’s policy.

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 create an organization-wide policy with a timeout constraint, then the timeout constraints in any policies that are targeted at specific repositories must fall within the restriction configured for the entire organization. The shortest timeout period - in an organization-wide policy, a policy targeted at specified repositories, or in someone's personal settings - is applied.

If you add an organization-wide policy with a timeout constraint, you should set the timeout to the longest acceptable period. You can then add separate policies that set the maximum timeout to a shorter period for specific repositories in your organization.

Note: Codespace policies only apply to codespaces for which your organization will be billed. If an individual user creates a codespace for a repository in your organization, and the organization is not billed, then the codespace will not be bound by these policies. For information on how to choose who can create codespaces that are billed to your organization, see "Enabling GitHub Codespaces for your organization."

Adding a policy to set a maximum idle timeout period

  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 Maximum idle timeout.

    Screenshot of the 'Add constraint' dropdown menu

  7. Click to edit the constraint.

    Screenshot of the pencil icon for editing the constraint

  8. Enter the maximum number of minutes codespaces can remain inactive before they time out, then click Save.

    Screenshot of setting the maximum timeout in minutes

  9. Click outside of the dialog box to close it.

  10. By default the policy is set to apply to all repositories, if you want it to apply only to some of the repositories in your organization, click All repositories and then click Selected repositories in the dropdown menu.

    Screenshot of choosing 'Selected repositories'

    With Selected repositories selected:

    1. Click .

      Screenshot of the gear icon for editing the settings

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

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

      Screenshot of selected repositories for this policy

  11. If you want to add another constraint to the policy, click Add constraint and choose another constraint. For information about other constraints, see:

  12. After you've finished adding constraints to your policy, click Save.

The policy will be applied to all new codespaces that are billable to your organization. The timeout constraint is also applied to existing codespaces the next time they are started.

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 set a maximum idle timeout period."
  2. Click the name of the policy you want to edit.
  3. Click the pencil icon () beside the "Maximum idle timeout" constraint.
  4. Make the required changes then click Save.

Deleting a policy

  1. Display the "Codespace policies" page. For more information, see "Adding a policy to set a maximum idle timeout period."

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

    Screenshot of the delete button for a policy