155 lines
8.9 KiB
Markdown
155 lines
8.9 KiB
Markdown
---
|
|
description: 'Learn how to use GitLab Pages to deploy a static website at no additional cost.'
|
|
stage: Plan
|
|
group: Knowledge
|
|
info: 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
|
|
---
|
|
|
|
# GitLab Pages **(FREE)**
|
|
|
|
With GitLab Pages, you can publish static websites directly from a repository
|
|
in GitLab.
|
|
|
|
<div class="row">
|
|
<div class="col-md-9">
|
|
<p style="margin-top: 18px;">
|
|
<ul>
|
|
<li>Use for any personal or business website.</li>
|
|
<li>Use any Static Site Generator (SSG) or plain HTML.</li>
|
|
<li>Create websites for your projects, groups, or user account.</li>
|
|
<li>Host your site on your own GitLab instance or on GitLab.com for free.</li>
|
|
<li>Connect your custom domains and TLS certificates.</li>
|
|
<li>Attribute any license to your content.</li>
|
|
</ul>
|
|
</p>
|
|
</div>
|
|
<div class="col-md-3"><img src="img/ssgs_pages.png" alt="Examples of SSGs supported by Pages" class="middle display-block"></div>
|
|
</div>
|
|
|
|
To publish a website with Pages, you can use any static site generator,
|
|
like Gatsby, Jekyll, Hugo, Middleman, Harp, Hexo, or Brunch. You can also
|
|
publish any website written directly in plain HTML, CSS, and JavaScript.
|
|
|
|
Pages does not support dynamic server-side processing, for instance, as `.php` and `.asp` requires.
|
|
For more information, see
|
|
[Static vs dynamic websites](https://about.gitlab.com/blog/2016/06/03/ssg-overview-gitlab-pages-part-1-dynamic-x-static/).
|
|
|
|
## Menu Position Test
|
|
|
|
NOTE:
|
|
We are currently conducting an A/B test where some users may see the Pages
|
|
Menu entry under "Deployments" instead of "Settings". We think that this may
|
|
be a more accurate position. Feel free to add any feedback to [the experiment issue](https://gitlab.com/gitlab-org/gitlab/-/issues/373547).
|
|
|
|
## Getting started
|
|
|
|
To create a GitLab Pages website:
|
|
|
|
| Document | Description |
|
|
|--------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
|
|
| [Use the GitLab UI to create a simple `.gitlab-ci.yml`](getting_started/pages_ui.md) | Add a Pages site to an existing project. Use the UI to set up a simple `.gitlab-ci.yml`. |
|
|
| [Create a `.gitlab-ci.yml` file from scratch](getting_started/pages_from_scratch.md) | Add a Pages site to an existing project. Learn how to create and configure your own CI file. |
|
|
| [Use a `.gitlab-ci.yml` template](getting_started/pages_ci_cd_template.md) | Add a Pages site to an existing project. Use a pre-populated CI template file. |
|
|
| [Fork a sample project](getting_started/pages_forked_sample_project.md) | Create a new project with Pages already configured by forking a sample project. |
|
|
| [Use a project template](getting_started/pages_new_project_template.md) | Create a new project with Pages already configured by using a template. |
|
|
|
|
To update a GitLab Pages website:
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [GitLab Pages domain names, URLs, and base URLs](getting_started_part_one.md) | Learn about GitLab Pages default domains. |
|
|
| [Explore GitLab Pages](introduction.md) | Requirements, technical aspects, specific GitLab CI/CD configuration options, Access Control, custom 404 pages, limitations, and FAQ. |
|
|
| [Custom domains and SSL/TLS Certificates](custom_domains_ssl_tls_certification/index.md) | Custom domains and subdomains, DNS records, and SSL/TLS certificates. |
|
|
| [Let's Encrypt integration](custom_domains_ssl_tls_certification/lets_encrypt_integration.md) | Secure your Pages sites with Let's Encrypt certificates, which are automatically obtained and renewed by GitLab. |
|
|
| [Redirects](redirects.md) | Set up HTTP redirects to forward one page to another. |
|
|
|
|
For more information, see:
|
|
|
|
| Document | Description |
|
|
|----------|-------------|
|
|
| [Static vs dynamic websites](https://about.gitlab.com/blog/2016/06/03/ssg-overview-gitlab-pages-part-1-dynamic-x-static/) | Static versus dynamic site overview. |
|
|
| [Modern static site generators](https://about.gitlab.com/blog/2016/06/10/ssg-overview-gitlab-pages-part-2/) | SSG overview. |
|
|
| [Build any SSG site with GitLab Pages](https://about.gitlab.com/blog/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/) | Use SSGs for GitLab Pages. |
|
|
|
|
## How it works
|
|
|
|
To use GitLab Pages, you must create a project in GitLab to upload your website's
|
|
files to. These projects can be either public, internal, or private.
|
|
|
|
GitLab always deploys your website from a specific folder called `public` in your
|
|
repository. When you create a new project in GitLab, a [repository](../repository/index.md)
|
|
becomes available automatically.
|
|
|
|
To deploy your site, GitLab uses its built-in tool called [GitLab CI/CD](../../../ci/index.md)
|
|
to build your site and publish it to the GitLab Pages server. The sequence of
|
|
scripts that GitLab CI/CD runs to accomplish this task is created from a file named
|
|
`.gitlab-ci.yml`, which you can [create and modify](getting_started/pages_from_scratch.md).
|
|
A specific `job` called `pages` in the configuration file makes GitLab aware that you're deploying a
|
|
GitLab Pages website.
|
|
|
|
You can either use the GitLab [default domain for GitLab Pages websites](getting_started_part_one.md#gitlab-pages-default-domain-names),
|
|
`*.gitlab.io`, or your own domain (`example.com`). In that case, you
|
|
must be an administrator in your domain's registrar (or control panel) to set it up with Pages.
|
|
|
|
The following diagrams show the workflows you might follow to get started with Pages.
|
|
|
|
<img src="img/new_project_for_pages_v12_5.png" alt="New projects for GitLab Pages">
|
|
|
|
## Access to your Pages site
|
|
|
|
If you're using GitLab Pages default domain (`.gitlab.io`), your website is
|
|
automatically secure and available under HTTPS. If you're using your own custom
|
|
domain, you can optionally secure it with SSL/TLS certificates.
|
|
|
|
If you're using GitLab.com, your website is publicly available to the internet.
|
|
To restrict access to your website, enable [GitLab Pages Access Control](pages_access_control.md).
|
|
|
|
If you're using a self-managed instance, your websites are published on your
|
|
own server, according to the [Pages settings](../../../administration/pages/index.md)
|
|
chosen by your sysadmin, who can make them public or internal.
|
|
|
|
## Pages examples
|
|
|
|
These GitLab Pages website examples can teach you advanced techniques to use
|
|
and adapt for your own needs:
|
|
|
|
- [Posting to your GitLab Pages blog from iOS](https://about.gitlab.com/blog/2016/08/19/posting-to-your-gitlab-pages-blog-from-ios/).
|
|
- [GitLab CI: Run jobs sequentially, in parallel, or build a custom pipeline](https://about.gitlab.com/blog/2020/12/10/basics-of-gitlab-ci-updated/).
|
|
- [GitLab CI: Deployment & environments](https://about.gitlab.com/blog/2021/02/05/ci-deployment-and-environments/).
|
|
- [Building a new GitLab docs site with Nanoc, GitLab CI, and GitLab Pages](https://about.gitlab.com/blog/2016/12/07/building-a-new-gitlab-docs-site-with-nanoc-gitlab-ci-and-gitlab-pages/).
|
|
- [Publish code coverage reports with GitLab Pages](https://about.gitlab.com/blog/2016/11/03/publish-code-coverage-report-with-gitlab-pages/).
|
|
|
|
## Administer GitLab Pages for self-managed instances
|
|
|
|
If you are running a self-managed instance of GitLab,
|
|
[follow the administration steps](../../../administration/pages/index.md) to configure Pages.
|
|
|
|
<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> Watch a [video tutorial](https://www.youtube.com/watch?v=dD8c7WNcc6s) about how to get started with GitLab Pages administration.
|
|
|
|
### Configure GitLab Pages in a Helm Chart (Kubernetes) instance
|
|
|
|
To configure GitLab Pages on instances deployed via Helm chart (Kubernetes), use either:
|
|
|
|
- [The `gitlab-pages` subchart](https://docs.gitlab.com/charts/charts/gitlab/gitlab-pages/).
|
|
- [An external GitLab Pages instance](https://docs.gitlab.com/charts/advanced/external-gitlab-pages/).
|
|
|
|
## Security for GitLab Pages
|
|
|
|
If your username is `example`, your GitLab Pages website is located at `example.gitlab.io`.
|
|
GitLab allows usernames to contain a `.`, so a user named `bar.example` could create
|
|
a GitLab Pages website `bar.example.gitlab.io` that effectively is a subdomain of your
|
|
`example.gitlab.io` website. Be careful if you use JavaScript to set cookies for your website.
|
|
The safe way to manually set cookies with JavaScript is to not specify the `domain` at all:
|
|
|
|
```javascript
|
|
// Safe: This cookie is only visible to example.gitlab.io
|
|
document.cookie = "key=value";
|
|
|
|
// Unsafe: This cookie is visible to example.gitlab.io and its subdomains,
|
|
// regardless of the presence of the leading dot.
|
|
document.cookie = "key=value;domain=.example.gitlab.io";
|
|
document.cookie = "key=value;domain=example.gitlab.io";
|
|
```
|
|
|
|
This issue doesn't affect users with a custom domain, or users who don't set any
|
|
cookies manually with JavaScript.
|