9.4 KiB
stage | group | info |
---|---|---|
Data Stores | Tenant Scale | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments |
Create a project (FREE)
You can create a project in many ways in GitLab.
Create a blank project
To create a blank project:
- On the top bar, select Main menu > Projects > View all projects.
- On the right of the page, select New project.
- Select Create blank project.
- Enter the project details:
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
a-zA-Z
), digit (0-9
), emoji, or underscore (_
). It can also contain dots (.
), pluses (+
), dashes (-
), or spaces. - In the Project slug field, enter the path to your project. The GitLab instance uses the slug as the URL path to the project. To change the slug, first enter the project name, then change the slug.
- In the Project deployment target (optional) field, select your project's deployment target. This information helps GitLab better understand its users and their deployment requirements.
- To modify the project's viewing and access rights for users, change the Visibility Level.
- To create README file so that the Git repository is initialized, has a default branch, and can be cloned, select Initialize repository with a README.
- To analyze the source code in the project for known security vulnerabilities, select Enable Static Application Security Testing (SAST).
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
- Select Create project.
Create a project from a built-in template
A built-in project template populates a new project with files to get you started. Built-in templates are sourced from the following groups:
Anyone can contribute a built-in template.
To create a project from a built-in template:
- On the top bar, select Main menu > Projects > View all projects.
- On the right of the page, select New project.
- Select Create from template.
- Select the Built-in tab.
- From the list of templates:
- To view a preview of the template, select Preview.
- To use a template for the project, select Use template.
- Enter the project details:
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
a-zA-Z
), digit (0-9
), emoji, or underscore (_
). It can also contain dots (.
), pluses (+
), dashes (-
), or spaces. - In the Project slug field, enter the path to your project. The GitLab instance uses the slug as the URL path to the project. To change the slug, first enter the project name, then change the slug.
- In the Project description (optional) field, enter the description of your project's dashboard.
- To modify the project's viewing and access rights for users, change the Visibility Level.
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
- Select Create project.
NOTE:
A user who creates a project from a template or by import is displayed as the author of the imported objects (such as issues and merge requests), which keep the original timestamp from the template or import.
Imported objects are labeled as By <username> on <timestamp> (imported from GitLab)
.
For this reason, the creation date of imported objects can be older than the creation date of the user's account. This can lead to objects appearing to have been created by a user before they even had an account.
Create a project from a custom template (PREMIUM)
Introduced in GitLab 11.2.
Custom project templates are available at:
- The instance-level
- The group-level
- On the top bar, select Main menu > Projects > View all projects.
- On the right of the page, select New project.
- Select Create from template.
- Select the Instance or Group tab.
- From the list of templates:
- To view a preview of the template, select Preview.
- To use a template for the project, select Use template.
- Enter the project details:
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
a-zA-Z
), digit (0-9
), emoji, or underscore (_
). It can also contain dots (.
), pluses (+
), dashes (-
), or spaces. - In the Project slug field, enter the path to your project. The GitLab instance uses the slug as the URL path to the project. To change the slug, first enter the project name, then change the slug.
- The description of your project's dashboard in the Project description (optional) field.
- To modify the project's viewing and access rights for users, change the Visibility Level.
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
- Select Create project.
Create a project from the HIPAA Audit Protocol template (ULTIMATE)
Introduced in GitLab 12.10
The HIPAA Audit Protocol template contains issues for audit inquiries in the HIPAA Audit Protocol published by the U.S Department of Health and Human Services.
To create a project from the HIPAA Audit Protocol template:
- On the top bar, select Main menu > Projects > View all projects.
- On the right of the page, select New project.
- Select Create from template.
- Select the Built-in tab.
- Locate the HIPAA Audit Protocol template:
- To view a preview of the template, select Preview.
- To use the template for the project, select Use template.
- Enter the project details:
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
a-zA-Z
), digit (0-9
), emoji, or underscore (_
). It can also contain dots (.
), pluses (+
), dashes (-
), or spaces. - In the Project slug field, enter the path to your project. The GitLab instance uses the slug as the URL path to the project. To change the slug, first enter the project name, then change the slug.
- In the Project description (optional) field, enter the description of your project's dashboard.
- To modify the project's viewing and access rights for users, change the Visibility Level.
- In the Project name field, enter the name of your project. The name must start with a lowercase or uppercase letter (
- Select Create project.
Create a new project with Git push
Introduced in GitLab 10.5.
Use git push
to push a local project repository to GitLab. After you push a repository,
GitLab creates your project in your chosen namespace.
You cannot use git push
to create projects with project paths that:
- Have previously been used.
- Have been renamed.
Previously used project paths have a redirect. The redirect causes push attempts to redirect requests to the renamed project location, instead of creating a new project. To create a new project for a previously used or renamed project, use the UI or the Projects API.
Prerequisites:
-
To push with SSH, you must have an SSH key that is added to your GitLab account.
-
You must have permission to add new projects to a namespace. To check if you have permission:
- On the top bar, select Main menu > Groups and find your group.
- In the upper-right corner, confirm that New project is visible. Contact your GitLab administrator if you require permission.
To push your repository and create a project:
-
Push with SSH or HTTPS:
-
To push with SSH:
git push --set-upstream git@gitlab.example.com:namespace/myproject.git master
-
To push with HTTPS:
git push --set-upstream https://gitlab.example.com/namespace/myproject.git master
-
For
gitlab.example.com
, use the domain name of the machine that hosts your Git repository. -
For
namespace
, use the name of your namespace. -
For
myproject
, use the name of your project. -
Optional. To export existing repository tags, append the
--tags
flag to yourgit push
command.
-
-
Optional. To configure the remote:
git remote add origin https://gitlab.example.com/namespace/myproject.git
When the push completes, GitLab displays the message:
remote: The private project namespace/myproject was created.
To view your new project, go to https://gitlab.example.com/namespace/myproject
.
Your project's visibility is set to Private by default. To change project visibility, adjust your
project's settings.
Related topics
- For a list of words that you cannot use as project names, see reserved project and group names.
- For a list of characters that you cannot use in project and group names, see limitations on project and group names.
- Manage projects.