gitlab-org--gitlab-foss/doc/user/group/index.md

Groups

With GitLab Groups you can assemble related projects together and grant members access to several projects at once.

Groups can also be nested in subgroups.

Find your groups by expanding the left menu and clicking Groups:

The Groups page displays all groups you are a member of, how many projects it holds, how many members it has, the group visibility, and, if you have enough permissions, a link to the group settings. By clicking the last button you can leave that group.

Use cases

You can create groups for numerous reasons. To name a few:

• Organize related projects under the same namespace, add members to that group and grant access to all their projects at once
• Create a group, include members of your team, and make it easier to @mention all the team at once in issues and merge requests
  • Create a group for your company members, and create subgroups for each individual team. Let's say you create a group called company-team, and among others, you created subgroups in this group for each individual team backend-team, frontend-team, and production-team:
    1. When you start a new implementation from an issue, you add a comment: "@company-team, let's do it! @company-team/backend-team you're good to go!"
    2. When your backend team needs help from frontend, they add a comment: "@company-team/frontend-team could you help us here please?"
    3. When the frontend team completes their implementation, they comment: "@company-team/backend-team, it's done! Let's ship it @company-team/production-team!"

Namespaces

In GitLab, a namespace is a unique name to be used as a user name, a group name, or a subgroup name.

• http://gitlab.example.com/username
• http://gitlab.example.com/groupname
• http://gitlab.example.com/groupname/subgroup_name

For example, consider a user named Alex:

1. Alex creates an account on GitLab.com with the username alex; their profile will be accessed under https://gitlab.example.com/alex
2. Alex creates a group for their team with the groupname alex-team; the group and its projects will be accessed under https://gitlab.example.com/alex-team
3. Alex creates a subgroup of alex-team with the subgroup name marketing; this subgroup and its projects will be accessed under https://gitlab.example.com/alex-team/marketing

By doing so:

• Any team member mentions Alex with @alex
• Alex mentions everyone from their team with @alex-team
• Alex mentions only the marketing team with @alex-team/marketing

Issues and merge requests within a group

Issues and merge requests are part of projects. For a given group, view all the issues and merge requests across all the projects in that group, together in a single list view.

Create a new group

For a list of words that are not allowed to be used as group names see the reserved names.

You can create a group in GitLab from:

1. The Groups page: expand the left menu, click Groups, and click the green button New group:

   

2. Elsewhere: expand the plus sign button on the top navbar and choose New group:

   

Add the following information:

1. Set the Group path which will be the namespace under which your projects will be hosted (path can contain only letters, digits, underscores, dashes and dots; it cannot start with dashes or end in dot).
2. The Group name will populate with the path. Optionally, you can change it. This is the name that will display in the group views.
3. Optionally, you can add a description so that others can briefly understand what this group is about.
4. Optionally, choose an avatar for your project.
5. Choose the visibility level.

Add users to a group

Add members to a group by navigating to the group's dashboard, and clicking Members:

Select the permission level and add the new member. You can also set the expiring date for that user, from which they will no longer have access to your group.

One of the benefits of putting multiple projects in one group is that you can give a user to access to all projects in the group with one action.

Consider we have a group with two projects:

• On the Group Members page we can now add a new user to the group.
• Now because this user is a Developer member of the group, he automatically gets Developer access to all projects within that group.

If necessary, you can increase the access level of an individual user for a specific project, by adding them again as a new member to the project with the new permission levels.

Request access to a group

As a group owner you can enable or disable non members to request access to your group. Go to the group settings and click on Allow users to request access.

As a user, you can request to be a member of a group. Go to the group you'd like to be a member of, and click the Request Access button on the right side of your screen.

---

Group owners and maintainers will be notified of your request and will be able to approve or decline it on the members page.

---

If you change your mind before your request is approved, just click the Withdraw Access Request button.

Add projects to a group

There are two different ways to add a new project to a group:

• Select a group and then click on the New project button.

  

  You can then continue on creating a project.

• While you are creating a project, select a group namespace you've already created from the dropdown menu.

  

Default project creation level

Group owners or administrators can allow users with the Developer role to create projects under groups.

By default, Developers and Maintainers can create projects under agroup, but this can be changed either within the group settings for a group, or be set globally by a GitLab administrator in the Admin area at Settings > General > Visibility and access controls.

Available settings are No one, Maintainers, or Developers + Maintainers.

Transfer projects into groups

Learn how to transfer a project into a group.

Sharing a project with a group

You can share your projects with a group and give your group members access to the project all at once.

Alternatively, you can lock the sharing with group feature.

Manage group memberships via LDAP

In GitLab Enterprise Edition it is possible to manage GitLab group memberships using LDAP groups. See the GitLab Enterprise Edition documentation for more information.

Transferring groups

From GitLab 10.5, groups can be transferred in the following ways:

• Top-level groups can be transferred to a group, converting them into subgroups.
• Subgroups can be transferred to a new parent group.
• Subgroups can be transferred out from a parent group, converting them into top-level groups.

When transferring groups, note:

• Changing a group's parent can have unintended side effects. See Redirects when changing repository paths.
• You can only transfer groups to groups you manage.
• You will need to update your local repositories to point to the new location.
• If the parent group's visibility is lower than the group's current visibility, visibility levels for subgroups and projects will be changed to match the new parent group's visibility.
• Only explicit group membership is transferred, not inherited membership. If the group's owners have only inherited membership, this would leave the group without an owner. In this case, the user transferring the group becomes the group's owner.

Group settings

Once you have created a group, you can manage its settings by navigating to the group's dashboard, and clicking Settings.

General settings

Besides giving you the option to edit any settings you've previously set when creating the group, you can also access further configurations for your group.

Changing a group's path

Changing a group's path can have unintended side effects. Read how redirects will behave before proceeding.

If you are vacating the path so it can be claimed by another group or user, you may need to rename the group name as well since both names and paths must be unique.

To change your group path:

1. Navigate to your group's Settings > General.
2. Enter a new name under "Group path".
3. Hit Save group.

CAUTION: Caution: It is currently not possible to rename a namespace if it contains a project with Container Registry tags, because the project cannot be moved.

TIP: TIP: If you want to retain ownership over the original namespace and protect the URL redirects, then instead of changing a group's path or renaming a username, you can create a new group and transfer projects to it.

Enforce 2FA to group members

Add a security layer to your group by enforcing two-factor authentication (2FA) to all group members.

Share with group lock

Prevent projects in a group from sharing a project with another group. This allows for tighter control over project access.

For example, consider you have two distinct teams (Group A and Group B) working together in a project. To inherit the group membership, you share the project between the two groups A and B. Share with group lock prevents any project within the group from being shared with another group. By doing so, you guarantee only the right group members have access to that projects.

To enable this feature, navigate to the group settings page. Select Share with group lock and Save the group.

Member Lock [STARTER]

With Member Lock it is possible to lock membership in project to the level of members in group.

Learn more about Member Lock.

Group-level file templates [PREMIUM]

Group-level file templates allow you to share a set of templates for common file types with every project in a group.

Learn more about Group-level file templates.

Group-level project templates [PREMIUM]

Define project templates at a group-level by setting a group as a template source. Learn more about group-level project templates.

Advanced settings

• Projects: view all projects within that group, add members to each project, access each project's settings, and remove any project from the same screen.
• Webhooks: configure webhooks to your group.
• Kubernetes cluster integration: connect your GitLab group with Kubernetes clusters.
• Audit Events: view Audit Events for the group. [STARTER ONLY]
• Pipelines quota: keep track of the pipeline quota for the group.