- GitLab Pages default domain names
- URLs and base URLs
- Custom domains
On this document, learn how to name your project for GitLab Pages according to your intended website’s URL.
If you use your own GitLab instance to deploy your site with GitLab Pages, verify your Pages
wildcard domain with your sysadmin. This guide is valid for any GitLab instance, provided that you
replace the Pages wildcard domain on GitLab.com (
*.gitlab.io) with your own.
If you set up a GitLab Pages project on GitLab,
it’s automatically accessible under a
is defined by your username on GitLab.com,
or the group name you created this project under.
For GitLab self-managed instances, replace
with your instance’s Pages domain. For GitLab.com,
Pages domains are
|Type of GitLab Pages||The name of the project created in GitLab||Website URL|
|Project pages owned by a user|
|Project pages owned by a group|
|Project pages owned by a subgroup|
To understand Pages domains clearly, read the examples below.
- You created a project called
blogunder your username
john, therefore your project URL is
https://gitlab.com/john/blog/. Once you enable GitLab Pages for this project, and build your site, you can access it at
- You created a group for all your websites called
websites, and a project within this group is called
blog. Your project URL is
https://gitlab.com/websites/blog/. Once you enable GitLab Pages for this project, the site is available at
- You created a group for your engineering department called
engineering, a subgroup for all your documentation websites called
docs, and a project within this subgroup is called
workflows. Your project URL is
https://gitlab.com/engineering/docs/workflows/. Once you enable GitLab Pages for this project, the site is available at
- Under your username,
john, you created a project called
john.gitlab.io. Your project URL is
https://gitlab.com/john/john.gitlab.io. Once you enable GitLab Pages for your project, your website is published under
- Under your group
websites, you created a project called
websites.gitlab.io. Your project’s URL is
https://gitlab.com/websites/websites.gitlab.io. Once you enable GitLab Pages for your project, your website is published under
- On GitLab.com, a project site is always available under
- On GitLab.com, a user or group website is available under
- On your GitLab instance, replace
gitlab.ioabove with your Pages server domain. Ask your sysadmin for this information.
baseurloption might be named differently in some static site generators.
Every Static Site Generator (SSG) default configuration expects
to find your website under a (sub)domain (
in a subdirectory of that domain (
whenever you publish a project website (
you must look for this configuration (base URL) on your SSG’s
documentation and set it up to reflect this pattern.
For example, for a Jekyll site, the
baseurl is defined in the Jekyll
_config.yml. If your website URL is
https://john.gitlab.io/blog/, you need to add this line to
On the contrary, if you deploy your website after forking one of
our default examples, the
already configured this way, as all examples there are project
websites. If you decide to make yours a user or group website, you
must remove this configuration from your project. For the Jekyll
example we just mentioned, you must change Jekyll’s
If you’re using the plain HTML example,
you don’t need to set a
GitLab Pages supports custom domains and subdomains, served under HTTP or HTTPS. See GitLab Pages custom domains and SSL/TLS Certificates for more information.