Project settings

Use the Settings page to manage the configuration options in your project.

View project settings

Prerequisite:

  • You must have at least the Maintainer role for the project.
  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. To display all settings in a section, select Expand.
  4. Optional. Use the search box to find a setting.

Edit project name and description

Use the project general settings to edit your project details.

Prerequisite:

  • You must have at least the Maintainer role for the project.
  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. In the Project name text box, enter your project name.
  4. In the Project description text box, enter your project description.
  5. Under Project avatar, to change your project avatar, select Choose file.

Assign topics to a project

Use topics to categorize projects and find similar new projects.

To assign topics to a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. In the Topics text box, enter the project topics. Popular topics are suggested as you type.
  4. Select Save changes.

If you’re an instance administrator, you can administer all project topics from the Admin Area’s Topics page.

note
The assigned topics are visible only to users with access to the project, but everyone can see which topics exist on the GitLab instance. Do not include sensitive information in the name of a topic.

Rename a repository

A project’s repository name defines its URL and its place on the file disk where GitLab is installed.

Prerequisite:

  • You must be an administrator or have the Maintainer or Owner role for the project.
note
When you change the repository path, users may experience issues if they push to, or pull from, the old URL. For more information, see redirects when renaming repositories.

To rename a repository:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. In the Change path text box, edit the path.
  5. Select Change path.

Configure project features and permissions

To configure features and permissions for a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Visibility, project features, permissions.
  4. To allow users to request access to the project, select the Users can request access checkbox.
  5. To enable or disable features in the project, use the feature toggles.
  6. Select Save changes.

When you disable a feature, the following additional features are also disabled:

  • If you disable the Issues feature, project users cannot use:

    • Issue Boards
    • Service Desk
    • Project users can still access Milestones from merge requests.
  • If you disable Issues and Merge Requests, project users cannot use:

    • Labels
    • Milestones
  • If you disable Repository, project users cannot access:

    • Merge requests
    • CI/CD
    • Container Registry
    • Git Large File Storage
    • Packages
  • The metrics dashboard requires read access to project environments and deployments. Users with access to the metrics dashboard can also access environments and deployments.

Configure merge request settings for a project

Configure your project’s merge request settings:

Delete the source branch on merge by default

In merge requests, you can change the default behavior so that the Delete the source branch checkbox is always selected.

To set this default:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > Merge requests.
  3. Select Enable “Delete source branch” option by default.
  4. Select Save changes.

Export project

You can export a project and its data.

Transfer a project to another namespace

When you transfer a project to another namespace, you move the project to a different group.

Prerequisites:

  • You must have at least the Maintainer role for the group you are transferring to.
  • You must be the Owner of the project you transfer.
  • The group must allow creation of new projects.
  • The project must not contain any container images.
  • The project must not have a security policy. If a security policy is assigned to the project, it is automatically unassigned during the transfer.
  • If the root namespace changes, you must remove npm packages that follow the naming convention from the project. After you transfer the project you can either:

    • Update the package scope with the new root namespace path, and publish it again to the project.
    • Republish the package to the project without updating the root namespace path, which causes the package to no longer follow the naming convention. If you republish the package without updating the root namespace path, it will not be available at the instance level endpoint.

To transfer a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. Under Transfer project, choose the namespace to transfer the project to.
  5. Select Transfer project.
  6. Enter the project’s name and select Confirm.

You are redirected to the project’s new page and GitLab applies a redirect. For more information about repository redirects, see What happens when a repository path changes.

note
If you are an administrator, you can also use the administration interface to move any project to any namespace.

Transferring a GitLab SaaS project to a different subscription tier

When you transfer a project from a namespace licensed for GitLab SaaS Premium or Ultimate to GitLab Free:

Archive a project

When you archive a project, the repository, packages, issues, merge requests, and all other features become read-only. Archived projects are also hidden from project lists.

To archive a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. In the Archive project section, select Archive project.
  5. To confirm, select OK.

Unarchive a project

When you unarchive a project, the read-only restriction is removed, and the project becomes available in project lists.

Prerequisite:

  • You must be an administrator or have the Owner role for the project.
  1. Find the archived project.
    1. On the left sidebar, select Search or go to.
    2. Select View all my projects.
    3. Select Explore projects.
    4. In the Sort projects dropdown list, select Show archived projects.
    5. In the Filter by name field, enter the project name.
    6. Select the project link.
  2. On the left sidebar, select Settings > General.
  3. Under Advanced, select Expand.
  4. In the Unarchive project section, select Unarchive project.
  5. To confirm, select OK.

Delete a project

Version history

You can mark a project to be deleted. After you delete a project:

  • Projects in personal namespaces are deleted immediately.
  • Projects in groups are deleted after a retention period.

Prerequisite:

  • You must have the Owner role for a project.

To delete a project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. In the Delete this project section, select Delete project.
  5. On the confirmation dialog, enter the project name and select Yes, delete project.

This action deletes the project and all associated resources (such as issues and merge requests).

You can also delete projects using the Rails console.

Delayed project deletion

Version history

Projects in a group (not a personal namespace) can be deleted after a delay period.

On self-managed instances, group administrators can define a deletion delay period of between 1 and 90 days. On SaaS, there is a non-adjustable default retention period of seven days.

You can view projects that are pending deletion, and use the Rails console to find projects that are pending deletion.

Delete a project immediately

Version history

If you don’t want to wait for delayed deletion, you can delete a project immediately. To do this, perform the steps for deleting a projects again.

In the first cycle of deleting a project, the project is moved to the delayed deletion queue and automatically deleted after the retention period has passed. If during this delayed deletion time you run a second deletion cycle, the project is deleted immediately.

Prerequisites:

To immediately delete a project marked for deletion:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. In the Delete this project section, select Delete project.
  5. On the confirmation dialog, enter the project name and select Yes, delete project.

Restore a project

Introduced in GitLab 12.6.

To restore a project marked for deletion:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Advanced.
  4. In the Restore project section, select Restore project.

Disable project analytics

By default, analytics for a project are displayed under the Analyze item in the left sidebar. To disable this feature and remove the Analyze item from the left sidebar:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Visibility, project features, permissions.
  4. Turn off the Analytics toggle.
  5. Select Save changes.

Disable CVE identifier request in issues

Introduced in GitLab 13.4, only for public projects on GitLab.com.

In some environments, users can submit a CVE identifier request in an issue.

To disable the CVE identifier request option in issues in your project:

  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Visibility, project features, permissions.
  4. Under Issues, turn off the CVE ID requests in the issue sidebar toggle.
  5. Select Save changes.

Disable project email notifications

Prerequisite:

  • You must have the Owner role for the project.
  1. On the left sidebar, select Search or go to and find your project.
  2. Select Settings > General.
  3. Expand Visibility, project features, permissions.
  4. Clear the Disable email notifications checkbox.

Troubleshooting

When working with project settings, you might encounter the following issues, or require alternate methods to complete specific tasks.

Transfer a project through console

If transferring a project through the UI or API is not working, you can attempt the transfer in a Rails console session.

p = Project.find_by_full_path('<project_path>')

# To set the owner of the project
current_user = p.creator

# Namespace where you want this to be moved
namespace = Namespace.find_by_full_path("<new_namespace>")

Projects::TransferService.new(p, current_user).execute(namespace)