GitLab Pages Access Control

  • Introduced in GitLab 11.5.
  • Available on GitLab.com in GitLab 12.4.

You can enable Pages access control on your project if your administrator has enabled the access control feature on your GitLab instance. When enabled, only members of your project (at least Guest) can access your website:

For a demonstration, see Pages access controls.

  1. Navigate to your project's Settings > General and expand Visibility, project features, permissions.

  2. Toggle the Pages button to enable the access control. If you don't see the toggle button, that means it isn't enabled. Ask your administrator to enable it.

  3. The Pages access control dropdown allows you to set who can view pages hosted with GitLab Pages, depending on your project's visibility:

    • If your project is private:
      • Only project members: Only project members are able to browse the website.
      • Everyone: Everyone, both logged into and logged out of GitLab, is able to browse the website, no matter their project membership.
    • If your project is internal:
      • Only project members: Only project members are able to browse the website.
      • Everyone with access: Everyone logged into GitLab is able to browse the website, no matter their project membership.
      • Everyone: Everyone, both logged into and logged out of GitLab, is able to browse the website, no matter their project membership.
    • If your project is public:
      • Only project members: Only project members are able to browse the website.
      • Everyone with access: Everyone, both logged into and logged out of GitLab, is able to browse the website, no matter their project membership.
  4. Click Save changes. Note that your changes may not take effect immediately. GitLab Pages uses a caching mechanism for efficiency. Your changes may not take effect until that cache is invalidated, which usually takes less than a minute.

The next time someone tries to access your website and the access control is enabled, they're presented with a page to sign into GitLab and verify they can access the website.

Terminating a Pages session

To sign out of your GitLab Pages website, revoke the application access token for GitLab Pages:

  1. In the top menu, select your profile, and then select Settings.
  2. In the left sidebar, select Applications.
  3. Scroll to the Authorized applications section, find the GitLab Pages entry, and select its Revoke button.