2019-09-04 21:01:54 +05:30
---
type: reference, howto
2020-06-23 00:09:42 +05:30
stage: Manage
group: Access
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-09-04 21:01:54 +05:30
---
2021-04-17 20:07:23 +05:30
# Groups **(FREE)**
2017-09-10 17:25:29 +05:30
2021-04-29 21:17:54 +05:30
In GitLab, you use groups to manage one or more related projects at the same time.
2019-09-04 21:01:54 +05:30
2021-04-29 21:17:54 +05:30
You can use groups to manage permissions for your projects. If someone has access to
the group, they get access to all the projects in the group.
2019-09-04 21:01:54 +05:30
2021-04-29 21:17:54 +05:30
You can also view all of the issues and merge requests for the projects in the group,
and view analytics that show the group's activity.
2017-09-10 17:25:29 +05:30
2021-04-29 21:17:54 +05:30
You can use groups to communicate with all of the members of the group at once.
2017-09-10 17:25:29 +05:30
2021-04-29 21:17:54 +05:30
For larger organizations, you can also create [subgroups ](subgroups/index.md ).
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
## View groups
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
To view groups:
2019-09-04 21:01:54 +05:30
2021-04-17 20:07:23 +05:30
1. In the top menu, select **Groups > Your Groups** . All groups you are a member of are displayed.
1. To view a list of public groups, select **Explore public groups** .
2019-09-04 21:01:54 +05:30
2021-04-17 20:07:23 +05:30
You can also view groups by namespace.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
### Namespaces
2019-09-04 21:01:54 +05:30
2021-04-17 20:07:23 +05:30
In GitLab, a namespace is a unique name and URL for a user, a group, or subgroup.
2017-09-10 17:25:29 +05:30
- `http://gitlab.example.com/username`
- `http://gitlab.example.com/groupname`
- `http://gitlab.example.com/groupname/subgroup_name`
2018-11-08 19:23:39 +05:30
For example, consider a user named Alex:
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. Alex creates an account with the username `alex` : `https://gitlab.example.com/alex`
1. Alex creates a group for their team with the group name `alex-team` .
The group and its projects are available at: `https://gitlab.example.com/alex-team`
1. Alex creates a subgroup of `alex-team` with the subgroup name `marketing` .
The subgroup and its projects are available at: `https://gitlab.example.com/alex-team/marketing`
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
## Create a group
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
To create a group:
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. From the top menu, either:
- Select **Groups > Your Groups** , and on the right, select the **New group** button.
- To the left of the search box, select the plus sign and then **New group** .
1. For the **Group name** , use only:
2019-10-12 21:52:04 +05:30
- Alphanumeric characters
2021-04-17 20:07:23 +05:30
- Emojis
2019-10-12 21:52:04 +05:30
- Underscores
2021-04-17 20:07:23 +05:30
- Dashes, dots, spaces, and parentheses (however, it cannot start with any of these characters)
For a list of words that cannot be used as group names, see [reserved names ](../reserved_names.md ).
1. For the **Group URL** , which is used for the [namespace ](#namespaces ),
use only:
2019-10-12 21:52:04 +05:30
- Alphanumeric characters
- Underscores
- Dashes and dots (it cannot start with dashes or end in a dot)
2017-09-10 17:25:29 +05:30
1. Choose the [visibility level ](../../public_access/public_access.md ).
2021-04-17 20:07:23 +05:30
1. Invite GitLab members or other users to join the group.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
< i class = "fa fa-youtube-play youtube" aria-hidden = "true" > < / i >
For details about groups, watch [GitLab Namespaces (users, groups and subgroups) ](https://youtu.be/r0sJgjR2f5A ).
2019-09-04 21:01:54 +05:30
2017-09-10 17:25:29 +05:30
## Add users to a group
2021-04-17 20:07:23 +05:30
You can give a user access to all projects in a group.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. From the top menu, select **Groups > Your Groups** .
1. Find your group and select it.
1. From the left sidebar, select **Members** .
1. Fill in the fields.
- The role applies to all projects in the group. [Learn more about permissions ](../permissions.md#permissions ).
- On the **Access expiration date** , the user can no longer access projects in the group.
2017-09-10 17:25:29 +05:30
## Request access to a group
2021-04-17 20:07:23 +05:30
As a user, you can request to be a member of a group, if an administrator allows it.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. From the top menu, select **Groups > Your Groups** .
1. Find the group and select it.
1. Under the group name, select **Request Access** .
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
As many as ten of the most-recently-active group owners receive an email with your request.
Any group owner can approve or decline the request.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
If you change your mind before your request is approved, select
**Withdraw Access Request**.
2019-12-04 20:38:33 +05:30
2021-04-17 20:07:23 +05:30
## Prevent users from requesting access to a group
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
As a group owner, you can prevent non-members from requesting access to
your group.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. From the top menu, select **Groups > Your Groups** .
1. Find the group and select it.
1. From the left menu, select **Settings > General** .
1. Expand the **Permissions, LFS, 2FA** section.
1. Clear the **Allow users to request access** checkbox.
1. Select **Save changes** .
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
## Change the owner of a group
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
You can change the owner of a group. Each group must always have at least one
member with [Owner permission ](../permissions.md#group-members-permissions ).
2020-03-13 15:44:24 +05:30
- As an administrator:
2021-04-17 20:07:23 +05:30
1. Go to the group and from the left menu, select **Members** .
2020-03-13 15:44:24 +05:30
1. Give a different member **Owner** permissions.
1. Refresh the page. You can now remove **Owner** permissions from the original owner.
- As the current group's owner:
2021-04-17 20:07:23 +05:30
1. Go to the group and from the left menu, select **Members** .
2020-03-13 15:44:24 +05:30
1. Give a different member **Owner** permissions.
1. Have the new owner sign in and remove **Owner** permissions from you.
2020-07-28 23:09:34 +05:30
## Remove a member from the group
2021-04-17 20:07:23 +05:30
Prerequisites:
2020-07-28 23:09:34 +05:30
2021-04-17 20:07:23 +05:30
- You must have [Owner permissions ](../permissions.md#group-members-permissions ).
- The member must have direct membership in the group. If
membership is inherited from a parent group, then the member can be removed
from the parent group only.
2020-07-28 23:09:34 +05:30
To remove a member from a group:
2021-04-17 20:07:23 +05:30
1. Go to the group.
1. From the left menu, select **Members** .
1. Next to the member you want to remove, select **Delete** .
1. Optional. On the **Remove member** confirmation box, select the
2021-04-29 21:17:54 +05:30
**Also unassign this user from linked issues and merge requests** checkbox.
2021-04-17 20:07:23 +05:30
1. Select **Remove member** .
2020-07-28 23:09:34 +05:30
2021-02-22 17:27:13 +05:30
## Filter and sort members in a group
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21727) in GitLab 12.6.
> - [Improved](https://gitlab.com/gitlab-org/gitlab/-/issues/228675) in GitLab 13.7.
2021-03-08 18:12:59 +05:30
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/289911) in GitLab 13.8.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
To find members in a group, you can sort, filter, or search.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
### Filter a group
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
Filter a group to find members. By default, all members in the group and subgroups are displayed.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group and select **Members** .
1. Above the list of members, in the **Filter members** box, enter filter criteria.
- To view members in the group only, select **Membership = Direct** .
- To view members of the group and its subgroups, select **Membership = Inherited** .
- To view members with two-factor authentication enabled or disabled, select **2FA = Enabled** or **Disabled** .
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
### Search a group
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
You can search for members by name, username, or email.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group and select **Members** .
1. Above the list of members, in the **Filter members** box, enter search criteria.
1. To the right of the **Filter members** box, select the magnifying glass (**{search}**).
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
### Sort members in a group
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
You can sort members by **Account** , **Access granted** , **Max role** , or **Last sign-in** .
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group and select **Members** .
1. Above the list of members, on the top right, from the **Account** list, select
the criteria to filter by.
1. To switch the sort between ascending and descending, to the right of the **Account** list, select the
arrow (**{sort-lowest}** or ** {sort-highest}**).
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
## Mention a group in an issue or merge request
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
When you mention a group in a comment, every member of the group gets a to-do item
added to their To-do list.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
1. Open the MR or issue.
1. In a comment, type `@` followed by the user, group, or subgroup namespace.
For example, `@alex` , `@alex-team` , or `@alex-team/marketing` .
1. Select **Comment** .
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
A to-do item is created for all the group and subgroup members.
2021-02-22 17:27:13 +05:30
2021-04-17 20:07:23 +05:30
## Change the default branch protection of a group
2020-04-08 14:13:33 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/7583) in GitLab 12.9.
2020-04-08 14:13:33 +05:30
By default, every group inherits the branch protection set at the global level.
To change this setting for a specific group:
2020-10-24 23:57:45 +05:30
1. Go to the group's **Settings > General** page.
2020-04-08 14:13:33 +05:30
1. Expand the **Permissions, LFS, 2FA** section.
1. Select the desired option in the **Default branch protection** dropdown list.
1. Click **Save changes** .
To change this setting globally, see [Default branch protection ](../admin_area/settings/visibility_and_access_controls.md#default-branch-protection ).
2021-02-22 17:27:13 +05:30
NOTE:
2020-11-24 15:15:51 +05:30
In [GitLab Premium or higher ](https://about.gitlab.com/pricing/ ), GitLab administrators can choose to [disable group owners from updating the default branch protection ](../admin_area/settings/visibility_and_access_controls.md#disable-group-owners-from-updating-default-branch-protection ).
2020-05-24 23:13:21 +05:30
2017-09-10 17:25:29 +05:30
## Add projects to a group
There are two different ways to add a new project to a group:
2021-03-11 19:13:27 +05:30
- Select a group, and then click **New project** . You can then continue [creating your project ](../../user/project/working_with_projects.md#create-a-project ).
2021-04-17 20:07:23 +05:30
- While you are creating a project, select a group from the dropdown menu.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
![Select group ](img/select_group_dropdown_13_10.png )
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
### Specify who can add projects to a group
2019-07-07 11:18:12 +05:30
2021-06-08 01:23:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/2534) in GitLab Premium 10.5.
> - [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25975) to GitLab Free in 11.10.
2019-07-31 22:56:46 +05:30
2019-12-21 20:55:43 +05:30
By default, [Developers and Maintainers ](../permissions.md#group-members-permissions ) can create projects under a group.
2019-07-07 11:18:12 +05:30
2019-12-21 20:55:43 +05:30
To change this setting for a specific group:
2019-07-07 11:18:12 +05:30
2019-12-21 20:55:43 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Select the desired option in the **Allowed to create projects** dropdown list.
1. Click **Save changes** .
To change this setting globally, see [Default project creation protection ](../admin_area/settings/visibility_and_access_controls.md#default-project-creation-protection ).
2019-07-07 11:18:12 +05:30
2021-04-17 20:07:23 +05:30
## Group activity analytics **(PREMIUM)**
2020-04-22 19:07:51 +05:30
2021-06-08 01:23:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/207164) in GitLab 12.10 as
2021-04-17 20:07:23 +05:30
a [beta feature ](https://about.gitlab.com/handbook/product/#beta ).
2020-04-22 19:07:51 +05:30
2021-04-17 20:07:23 +05:30
For a group, you can view how many merge requests, issues, and members were created in the last 90 days.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
These Group Activity Analytics can be enabled with the `group_activity_analytics` [feature flag ](../../development/feature_flags/index.md#enabling-a-feature-flag-locally-in-development ).
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
![Recent Group Activity ](img/group_activity_analytics_v13_10.png )
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
### View group activity
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
You can view the most recent actions taken in a group.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
1. From the top menu, select **Groups > Your Groups** .
1. Find the group and select it.
1. From the left menu, select **Group overview > Activity** .
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
To view the activity feed in Atom format, select the
**RSS** (**{rss}**) icon.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
## Share a group with another group
2020-03-13 15:44:24 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/18328) in GitLab 12.7.
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
NOTE:
In GitLab 13.11, you can [replace this form with a modal window ](#share-a-group-modal-window ).
2021-04-17 20:07:23 +05:30
Similar to how you [share a project with a group ](../project/members/share_project_with_groups.md ),
you can share a group with another group. Members get direct access
2021-06-08 01:23:25 +05:30
to the shared group. This includes members who inherited group membership from a parent group.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
To share a given group, for example, `Frontend` with another group, for example,
`Engineering` :
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the `Frontend` group.
1. From the left menu, select **Members** .
2020-03-13 15:44:24 +05:30
1. Select the **Invite group** tab.
2021-04-17 20:07:23 +05:30
1. In the **Select a group to invite** list, select `Engineering` .
1. For the **Max access level** , select an access level.
1. Select **Invite** .
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
All the members of the `Engineering` group are added to the `Frontend` group.
2020-03-13 15:44:24 +05:30
2021-04-29 21:17:54 +05:30
### Share a group modal window
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/247208) in GitLab 13.11.
> - [Deployed behind a feature flag](../feature_flags.md), disabled by default.
> - Enabled on GitLab.com.
> - Recommended for production use.
> - Replaces the existing form with buttons to open a modal window.
> - To use in GitLab self-managed instances, ask a GitLab administrator to [enable it](../project/members/index.md#enable-or-disable-modal-window). **(FREE SELF)**
WARNING:
This feature might not be available to you. Check the **version history** note above for details.
In GitLab 13.11, you can optionally replace the sharing form with a modal window.
To share a group after enabling this feature:
1. Go to your group's page.
1. In the left sidebar, go to **Members** , and then select **Invite a group** .
1. Select a group, and select a **Max access level** .
1. (Optional) Select an **Access expiration date** .
1. Select **Invite** .
2021-03-11 19:13:27 +05:30
## Manage group memberships via LDAP **(PREMIUM SELF)**
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
Group syncing allows LDAP groups to be mapped to GitLab groups. This provides more control over per-group user management. To configure group syncing, edit the `group_base` **DN** (`'OU=Global Groups,OU=GitLab INT,DC=GitLab,DC=org'`). This **OU** contains all groups that will be associated with GitLab groups.
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
Group links can be created by using either a CN or a filter. To create these group links, go to the group's **Settings > LDAP Synchronization** page. After configuring the link, it may take more than an hour for the users to sync with the GitLab group.
2020-06-23 00:09:42 +05:30
2020-11-24 15:15:51 +05:30
For more information on the administration of LDAP and group sync, refer to the [main LDAP documentation ](../../administration/auth/ldap/index.md#group-sync ).
2020-06-23 00:09:42 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2021-04-17 20:07:23 +05:30
When you add LDAP synchronization, if an LDAP user is a group member and they are not part of the LDAP group, they are removed from the group.
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
### Create group links via CN **(PREMIUM SELF)**
2020-06-23 00:09:42 +05:30
To create group links via CN:
2021-03-11 19:13:27 +05:30
<!-- vale gitlab.Spelling = NO -->
2020-06-23 00:09:42 +05:30
1. Select the **LDAP Server** for the link.
2021-04-17 20:07:23 +05:30
1. As the **Sync method** , select `LDAP Group cn` .
1. In the **LDAP Group cn** field, begin typing the CN of the group. There is a dropdown menu with matching CNs in the configured `group_base` . Select your CN from this list.
2020-06-23 00:09:42 +05:30
1. In the **LDAP Access** section, select the [permission level ](../permissions.md ) for users synced in this group.
2021-04-17 20:07:23 +05:30
1. Select the **Add Synchronization** button.
2020-06-23 00:09:42 +05:30
2021-03-11 19:13:27 +05:30
<!-- vale gitlab.Spelling = YES -->
2021-04-17 20:07:23 +05:30
### Create group links via filter **(PREMIUM SELF)**
2020-06-23 00:09:42 +05:30
To create group links via filter:
1. Select the **LDAP Server** for the link.
2021-04-17 20:07:23 +05:30
1. As the **Sync method** , select `LDAP user filter` .
2020-11-24 15:15:51 +05:30
1. Input your filter in the **LDAP User filter** box. Follow the [documentation on user filters ](../../administration/auth/ldap/index.md#set-up-ldap-user-filter ).
2020-06-23 00:09:42 +05:30
1. In the **LDAP Access** section, select the [permission level ](../permissions.md ) for users synced in this group.
2021-04-17 20:07:23 +05:30
1. Select the **Add Synchronization** button.
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
### Override user permissions **(PREMIUM SELF)**
2020-06-23 00:09:42 +05:30
2021-04-17 20:07:23 +05:30
LDAP user permissions can be manually overridden by an administrator. To override a user's permissions:
2020-06-23 00:09:42 +05:30
1. Go to your group's **Members** page.
2021-04-17 20:07:23 +05:30
1. In the row for the user you are editing, select the pencil (**{pencil}**) icon.
1. Select the brown **Edit permissions** button in the modal.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
Now you can edit the user's permissions from the **Members** page.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
## Transfer a group
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
You can transfer groups in the following ways:
2018-03-17 18:26:18 +05:30
2019-09-04 21:01:54 +05:30
- Transfer a subgroup to a new parent group.
- Convert a top-level group into a subgroup by transferring it to the desired group.
- Convert a subgroup into a top-level group by transferring it out of its current group.
2018-03-17 18:26:18 +05:30
2019-07-07 11:18:12 +05:30
When transferring groups, note:
2018-03-17 18:26:18 +05:30
2021-03-11 19:13:27 +05:30
- Changing a group's parent can have unintended side effects. See [Redirects when changing repository paths ](../project/repository/index.md#redirects-when-changing-repository-paths ).
2019-07-07 11:18:12 +05:30
- You can only transfer groups to groups you manage.
2019-09-04 21:01:54 +05:30
- You must update your local repositories to point to the new location.
2021-04-17 20:07:23 +05:30
- If the immediate parent group's visibility is lower than the group's current visibility, visibility levels for subgroups and projects change to match the new parent group's visibility.
2019-09-04 21:01:54 +05:30
- Only explicit group membership is transferred, not inherited membership. If the group's owners have only inherited membership, this leaves the group without an owner. In this case, the user transferring the group becomes the group's owner.
2021-04-17 20:07:23 +05:30
- Transfers fail if [packages ](../packages/index.md ) exist in any of the projects in the group, or in any of its subgroups.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
## Change a group's path
2018-03-17 18:26:18 +05:30
2020-10-24 23:57:45 +05:30
Changing a group's path (group URL) can have unintended side effects. Read
2021-04-17 20:07:23 +05:30
[how redirects behave ](../project/repository/index.md#redirects-when-changing-repository-paths )
before you proceed.
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
If you are changing the path so it can be claimed by another group or user,
you may need to rename the group too. Both names and paths must
2018-03-17 18:26:18 +05:30
be unique.
2021-04-17 20:07:23 +05:30
To retain ownership of the original namespace and protect the URL redirects,
create a new group and transfer projects to it instead.
2020-10-24 23:57:45 +05:30
To change your group path (group URL):
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
1. Go to your group's **Settings > General** page.
2019-09-30 21:07:59 +05:30
1. Expand the **Path, transfer, remove** section.
2021-04-17 20:07:23 +05:30
1. Under **Change group URL** , enter a new name.
1. Select **Change group URL** .
2018-03-17 18:26:18 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2021-04-17 20:07:23 +05:30
It is not possible to rename a namespace if it contains a
2019-12-04 20:38:33 +05:30
project with [Container Registry ](../packages/container_registry/index.md ) tags,
2018-03-17 18:26:18 +05:30
because the project cannot be moved.
2021-04-17 20:07:23 +05:30
## Use a custom name for the initial branch
2021-01-29 00:20:46 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/43290) in GitLab 13.6.
2021-04-29 21:17:54 +05:30
When you create a new project in GitLab, a default branch is created with the
first push. The group owner can
[customize the initial branch ](../project/repository/branches/default.md#group-level-custom-initial-branch-name )
for the group's projects to meet your group's needs.
2021-01-29 00:20:46 +05:30
2021-04-17 20:07:23 +05:30
## Remove a group
2020-03-13 15:44:24 +05:30
To remove a group and its contents:
2021-04-17 20:07:23 +05:30
1. Go to your group's **Settings > General** page.
2020-03-13 15:44:24 +05:30
1. Expand the **Path, transfer, remove** section.
2021-04-17 20:07:23 +05:30
1. In the Remove group section, select **Remove group** .
1. Confirm the action.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
This action removes the group. It also adds a background job to delete all projects in the group.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
Specifically:
2021-01-29 00:20:46 +05:30
2021-04-17 20:07:23 +05:30
- In [GitLab 12.8 and later ](https://gitlab.com/gitlab-org/gitlab/-/issues/33257 ), on [Premium ](https://about.gitlab.com/pricing/premium/ ) or higher tiers, this action adds a background job to mark a group for deletion. By default, the job schedules the deletion 7 days in the future. You can modify this waiting period through the [instance settings ](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay ).
- In [GitLab 13.6 and later ](https://gitlab.com/gitlab-org/gitlab/-/issues/39504 ), if the user who sets up the deletion is removed from the group before the
deletion happens, the job is cancelled, and the group is no longer scheduled for deletion.
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
## Restore a group **(PREMIUM)**
2020-03-13 15:44:24 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/33257) in GitLab 12.8.
2020-03-13 15:44:24 +05:30
To restore a group that is marked for deletion:
2021-04-17 20:07:23 +05:30
1. Go to your group's **Settings > General** page.
2020-03-13 15:44:24 +05:30
1. Expand the **Path, transfer, remove** section.
2021-04-17 20:07:23 +05:30
1. In the Restore group section, select **Restore group** .
2020-03-13 15:44:24 +05:30
2021-04-17 20:07:23 +05:30
## Prevent a project from being shared with groups
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
Prevent projects in a group from [sharing
2019-09-04 21:01:54 +05:30
a project with another group](../project/members/share_project_with_groups.md) to enable tighter control over project access.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
To prevent a project from being shared with other groups:
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
2021-04-29 21:17:54 +05:30
1. Select **Prevent sharing a project within `<group_name>` with other groups** .
2021-04-17 20:07:23 +05:30
1. Select **Save changes** .
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
## Prevent members from being added to a group **(PREMIUM)**
2018-03-17 18:26:18 +05:30
2021-04-17 20:07:23 +05:30
As a group owner, you can prevent any new project membership for all
projects in a group, allowing tighter control over project membership.
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
For example, if you want to lock the group for an [Audit Event ](../../administration/audit_events.md ),
2021-04-17 20:07:23 +05:30
you can guarantee that project membership cannot be modified during the audit.
2017-09-10 17:25:29 +05:30
2021-04-17 20:07:23 +05:30
To prevent members from being added to a group:
2018-12-13 13:39:08 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Under **Member lock** , select **Prevent adding new members to project membership within this group** .
1. Select **Save changes** .
2018-12-13 13:39:08 +05:30
2021-04-17 20:07:23 +05:30
All users who previously had permissions can no longer add members to a group.
API requests to add a new user to a project are not possible.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
## Restrict group access by IP address **(PREMIUM)**
2019-09-30 21:07:59 +05:30
2021-03-11 19:13:27 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/1985) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 12.0.
> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/215410) to [GitLab Premium](https://about.gitlab.com/pricing/) in 13.1.
2019-09-30 21:07:59 +05:30
2021-04-17 20:07:23 +05:30
To ensure only people from your organization can access particular
2021-04-29 21:17:54 +05:30
resources, you can restrict access to groups by IP address. This group-level setting
applies to:
2019-09-30 21:07:59 +05:30
2021-04-29 21:17:54 +05:30
- The GitLab UI, including subgroups, projects, and issues.
2021-04-17 20:07:23 +05:30
- [In GitLab 12.3 and later ](https://gitlab.com/gitlab-org/gitlab/-/issues/12874 ), the API.
2019-12-21 20:55:43 +05:30
2021-04-29 21:17:54 +05:30
You should consider these security implications before configuring IP address restrictions:
- **SSH requests**: While you can restrict HTTP traffic on GitLab.com with IP address restrictions,
they cause SSH requests, including Git operations over SSH, to fail. For more information,
read [issue 271673 ](https://gitlab.com/gitlab-org/gitlab/-/issues/271673 ).
- **Administrators and group owners**: Users with these permission levels can always
access the group settings, regardless of IP restriction, but they cannot access projects
belonging to the group when accessing from a disallowed IP address.
- **GitLab API and runner activities**: Only the [Groups ](../../api/groups.md )
and [Projects ](../../api/projects.md ) APIs are protected by IP address restrictions.
When you register a runner, it is not bound by the IP restrictions. When the runner
requests a new job or an update to a job's state, it is also not bound by
the IP restrictions. But when the running CI/CD job sends Git requests from a
restricted IP address, the IP restriction prevents code from being cloned.
2019-09-30 21:07:59 +05:30
2021-04-17 20:07:23 +05:30
To restrict group access by IP address:
2020-07-28 23:09:34 +05:30
2021-04-29 21:17:54 +05:30
1. Go to the group's **Settings > General** page.
2021-04-17 20:07:23 +05:30
1. Expand the **Permissions, LFS, 2FA** section.
1. In the **Allow access to the following IP addresses** field, enter IP address ranges in CIDR notation.
1. Select **Save changes** .
2020-07-28 23:09:34 +05:30
2021-04-29 21:17:54 +05:30
![Domain restriction by IP address ](img/restrict-by-ip.gif )
2021-01-29 00:20:46 +05:30
2021-04-17 20:07:23 +05:30
## Restrict group access by domain **(PREMIUM)**
2019-10-12 21:52:04 +05:30
2021-03-11 19:13:27 +05:30
>- [Introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/7297 ) in [GitLab Premium ](https://about.gitlab.com/pricing/ ) 12.2.
2021-04-17 20:07:23 +05:30
>- Support for specifying multiple email domains [introduced ](https://gitlab.com/gitlab-org/gitlab/-/issues/33143 ) added in GitLab 13.1.
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
You can prevent users with email addresses in specific domains from being added to a group.
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
To restrict group access by domain:
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. In the **Restrict membership by email** field, enter the domain names.
1. Select **Save changes** .
2019-10-12 21:52:04 +05:30
2021-01-29 00:20:46 +05:30
![Domain restriction by email ](img/restrict-by-email.gif )
2021-04-17 20:07:23 +05:30
Any time you attempt to add a new user, they are compared against this list.
Some domains cannot be restricted. These are the most popular public email domains, such as:
- `gmail.com` , `yahoo.com` , `aol.com` , `icloud.com`
- `hotmail.com` , `hotmail.co.uk` , `hotmail.fr`
- `msn.com` , `live.com` , `outlook.com`
2019-10-12 21:52:04 +05:30
2021-03-11 19:13:27 +05:30
NOTE:
2021-04-17 20:07:23 +05:30
Domain restrictions apply to groups only. They do not prevent users from being added as members of projects owned by the restricted group.
2021-03-11 19:13:27 +05:30
2021-04-17 20:07:23 +05:30
## Group file templates **(PREMIUM)**
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
Use group file templates to share a set of templates for common file
2019-07-31 22:56:46 +05:30
types with every project in a group. It is analogous to the
2021-04-17 20:07:23 +05:30
[instance template repository ](../admin_area/settings/instance_template_repository.md ).
The selected project should follow the same naming conventions as
2019-07-31 22:56:46 +05:30
are documented on that page.
2019-09-04 21:01:54 +05:30
You can only choose projects in the group as the template source.
This includes projects shared with the group, but it **excludes** projects in
2019-07-31 22:56:46 +05:30
subgroups or parent groups of the group being configured.
2020-07-28 23:09:34 +05:30
You can configure this feature for both subgroups and immediate parent groups. A project
2021-04-17 20:07:23 +05:30
in a subgroup has access to the templates for that subgroup, as well as
2020-07-28 23:09:34 +05:30
any immediate parent groups.
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
To learn how to create templates for issues and merge requests, see
[Description templates ](../project/description_templates.md ).
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
Define project templates at a group level by setting a group as the template source.
[Learn more about group-level project templates ](custom_project_templates.md ). ** (PREMIUM)**
2019-07-31 22:56:46 +05:30
2021-04-17 20:07:23 +05:30
### Enable group file template **(PREMIUM)**
2018-12-13 13:39:08 +05:30
2021-04-17 20:07:23 +05:30
To enable group file templates:
2021-03-11 19:13:27 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Templates** section.
1. Choose a project to act as the template repository.
1. Select **Save changes** .
2019-02-15 15:39:39 +05:30
2021-04-17 20:07:23 +05:30
## Disable email notifications
2019-10-12 21:52:04 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/23585) in GitLab 12.2.
2019-12-26 22:10:19 +05:30
You can disable all email notifications related to the group, which includes its subgroups and projects.
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
To disable email notifications:
2019-12-04 20:38:33 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Select **Disable email notifications** .
1. Select **Save changes** .
2019-10-12 21:52:04 +05:30
2021-04-17 20:07:23 +05:30
## Disable group mentions
2020-01-01 13:55:28 +05:30
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21301) in GitLab 12.6.
2020-01-01 13:55:28 +05:30
You can prevent users from being added to a conversation and getting notified when
anyone mentions a group in which those users are members.
Groups with disabled mentions are visualized accordingly in the autocompletion dropdown.
This is particularly helpful for groups with a large number of users.
2021-04-17 20:07:23 +05:30
To disable group mentions:
2020-01-01 13:55:28 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Select **Disable group mentions** .
1. Select **Save changes** .
2020-01-01 13:55:28 +05:30
2021-04-17 20:07:23 +05:30
## Enable delayed project removal **(PREMIUM)**
2020-07-28 23:09:34 +05:30
2021-06-08 01:23:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) in GitLab 13.2.
> - [Inheritance and enforcement added](https://gitlab.com/gitlab-org/gitlab/-/issues/321724) in GitLab 13.11.
2020-07-28 23:09:34 +05:30
2021-04-17 20:07:23 +05:30
By default, projects in a group are deleted immediately.
2021-03-11 19:13:27 +05:30
Optionally, on [Premium ](https://about.gitlab.com/pricing/ ) or higher tiers,
2021-04-17 20:07:23 +05:30
you can configure the projects in a group to be deleted after a delayed interval.
2020-07-28 23:09:34 +05:30
2021-04-17 20:07:23 +05:30
During this interval period, the projects are in a read-only state and can be restored, if required.
The interval period defaults to 7 days, and can be modified by an administrator in the [instance settings ](../admin_area/settings/visibility_and_access_controls.md#default-deletion-delay ).
2020-07-28 23:09:34 +05:30
To enable delayed deletion of projects:
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Check **Enable delayed project removal** .
2021-06-08 01:23:25 +05:30
1. Optional. To prevent subgroups from changing this setting, select **Enforce for all subgroups** .
2021-04-17 20:07:23 +05:30
1. Select **Save changes** .
2020-07-28 23:09:34 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2021-06-08 01:23:25 +05:30
In GitLab 13.11 and above the group setting for delayed project removal is inherited by subgroups. As discussed in [Cascading settings ](../../development/cascading_settings.md ) inheritance can be overridden, unless enforced by an ancestor.
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
## Prevent project forking outside group **(PREMIUM)**
2020-10-24 23:57:45 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216987) in GitLab 13.3.
2021-04-17 20:07:23 +05:30
By default, projects in a group can be forked.
2021-03-11 19:13:27 +05:30
Optionally, on [Premium ](https://about.gitlab.com/pricing/ ) or higher tiers,
2021-04-17 20:07:23 +05:30
you can prevent the projects in a group from being forked outside of the current top-level group.
2020-10-24 23:57:45 +05:30
Previously this setting was available only for groups enforcing group managed account. This setting will be
2021-04-17 20:07:23 +05:30
removed from SAML setting page and migrated to group settings. In the interim period, both of these settings are taken into consideration.
If even one is set to `true` then it will be assumed the group does not allow forking projects outside.
2020-10-24 23:57:45 +05:30
To enable prevent project forking:
2021-04-17 20:07:23 +05:30
1. Go to the top-level group's **Settings > General** page.
1. Expand the **Permissions, LFS, 2FA** section.
1. Check **Prevent project forking outside current group** .
1. Select **Save changes** .
2019-09-04 21:01:54 +05:30
2021-04-17 20:07:23 +05:30
## Group push rules **(PREMIUM)**
2020-05-24 23:13:21 +05:30
2021-06-08 01:23:25 +05:30
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34370) in GitLab 12.8.
2020-11-24 15:15:51 +05:30
> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/224129) in GitLab 13.4.
2020-05-24 23:13:21 +05:30
Group push rules allow group maintainers to set
2021-04-17 20:07:23 +05:30
[push rules ](../../push_rules/push_rules.md ) for newly created projects in the specific group.
2020-05-24 23:13:21 +05:30
2021-04-17 20:07:23 +05:30
To configure push rules for a group:
2020-05-24 23:13:21 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the groups's **Push Rules** page.
1. Select the settings you want.
1. Select **Save Push Rules** .
The group's new subgroups have push rules set for them based on either:
2020-05-24 23:13:21 +05:30
- The closest parent group with push rules defined.
- Push rules set at the instance level, if no parent groups have push rules defined.
2021-04-17 20:07:23 +05:30
## Related topics
2021-04-29 21:17:54 +05:30
- [Group wikis ](../project/wiki/index.md )
2021-04-17 20:07:23 +05:30
- [Maximum artifacts size ](../admin_area/settings/continuous_integration.md#maximum-artifacts-size ). ** (FREE SELF)**
- [Repositories analytics ](repositories_analytics/index.md ): View overall activity of all projects with code coverage. ** (PREMIUM)**
- [Contribution analytics ](contribution_analytics/index.md ): View the contributions (pushes, merge requests,
and issues) of group members. ** (PREMIUM)**
- [Issue analytics ](issues_analytics/index.md ): View a bar chart of your group's number of issues per month. ** (PREMIUM)**
- Use GitLab as a [dependency proxy ](../packages/dependency_proxy/index.md ) for upstream Docker images.
- [Epics ](epics/index.md ): Track groups of issues that share a theme. ** (ULTIMATE)**
- [Security Dashboard ](../application_security/security_dashboard/index.md ): View the vulnerabilities of all
the projects in a group and its subgroups. ** (ULTIMATE)**
- [Insights ](insights/index.md ): Configure insights like triage hygiene, issues created/closed per a given period, and
average time for merge requests to be merged. ** (ULTIMATE)**
- [Webhooks ](../project/integrations/webhooks.md ).
- [Kubernetes cluster integration ](clusters/index.md ).
- [Audit Events ](../../administration/audit_events.md#group-events ). ** (PREMIUM)**
- [Pipelines quota ](../admin_area/settings/continuous_integration.md ): Keep track of the pipeline quota for the group.
- [Integrations ](../admin_area/settings/project_integration_management.md ).
- [Transfer a project into a group ](../project/settings/index.md#transferring-an-existing-project-into-another-namespace ).
- [Share a project with a group ](../project/members/share_project_with_groups.md ): Give all group members access to the project at once.
- [Lock the sharing with group feature ](#prevent-a-project-from-being-shared-with-groups ).
- [Enforce two-factor authentication (2FA) ](../../security/two_factor_authentication.md#enforcing-2fa-for-all-users-in-a-group ): Enforce 2FA
for all group members.
2021-04-29 21:17:54 +05:30
## Troubleshooting
### Verify if access is blocked by IP restriction
If a user sees a 404 when they would normally expect access, and the problem is limited to a specific group, search the `auth.log` rails log for one or more of the following:
- `json.message` : `'Attempting to access IP restricted group'`
- `json.allowed` : `false`
In viewing the log entries, compare the `remote.ip` with the list of
[allowed IPs ](#restrict-group-access-by-ip-address ) for the group.