Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,6 @@ sidebar:

---

For security reasons, Cloudflare attempts to verify the email address associated with your account. You cannot perform certain tasks within the Cloudflare dashboard - for example, [adding a new member](/fundamentals/setup/manage-members/manage/#add-account-members) or [updating your communication preferences](/fundamentals/setup/account/customize-account/communication-preference/) - without verifying your email.
import { Render } from "~/components"

## When creating your account

When you first [create an account](/fundamentals/setup/account/create-account/), Cloudflare automatically sends a message to the email address you provided for your account.

To verify your email:

1. Log into your email provider and find your recent message from Cloudflare. If you cannot find the message, check your Spam folder.
2. Click the link in the email.
3. Log into Cloudflare to verify the email address associated with your account.

:::note


If someone else used your email to sign up for a Cloudflare account, you can remove this account by going to our [unintended registration](https://dash.cloudflare.com/unintended-registration) page and entering the information at the end of your confirmation email.


:::

***

## Resend verification emails

If you cannot find your verification email or your email has expired, request another verification email:

1. Log into the [Cloudflare dashboard](https://dash.cloudflare.com).
2. Go to **My Profile**.
3. For **Email Address**, select **Send verification email** (if this option is not available, your email has already been verified).

***

## Verification issues

If you experience issues with your verification link, you might have already verified your email address.

To check:

1. Log into the [Cloudflare dashboard](https://dash.cloudflare.com).
2. Go to **My Profile**.
3. For **Email Address**, your email address will have `(verified)` added after it.

If your email is still not verified, try clicking the verification link in a different browser or an incognito window.

If this still does not work, try [resending](#resend-verification-emails) the verification email to get a new verification link.
<Render file="create-account" product="fundamentals" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Create an account
pcx_content_type: overview
sidebar:
order: 1

---

import { Render } from "~/components"

<Render file="create-account" product="fundamentals" />

## Best practices

<Render file="create-account-best-practices" product="fundamentals" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: Cloudflare account setup
pcx_content_type: overview
sidebar:
label: Cloudflare account setup
order: 1
---

Before you can create your website, you will need to create and set up your Cloudflare account.

## Objectives

By the end of this module, you will:

- Sign up for an account with Cloudflare
- Verify your email address
- Log into your Cloudflare account
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Log in to Cloudflare
pcx_content_type: overview
sidebar:
order: 3

---

import { Render } from "~/components"

<Render file="create-account" product="fundamentals" />

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Verify email address
pcx_content_type: overview
sidebar:
order: 2

---

import { Render } from "~/components"

<Render file="verify-email-address" product="fundamentals" />

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Add a domain
pcx_content_type: overview
sidebar:
order: 1

---

import { Render } from "~/components"

<Render file="add-site" product="fundamentals" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Add a domain
pcx_content_type: overview
sidebar:
order: 2
---

Add your domain to Cloudflare to start receiving the benefits of the platform.

## Objectives

By the end of this module, you will:

- Add your domain as a new site to Cloudflare
- Update your nameservers
- Minimize downtime for your site
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Minimize downtime
pcx_content_type: overview
sidebar:
order: 3

---

import { Render } from "~/components"

<Render file="minimize-downtime" product="fundamentals" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Update your nameservers
pcx_content_type: overview
sidebar:
order: 2

---

import { Render } from "~/components"

<Render file="update-nameservers" product="fundamentals" />
15 changes: 15 additions & 0 deletions src/content/docs/learning-paths/personal-website/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: Build a personal website
type: developers-site
new_learning_path: true
pcx_content_type: learning-path
head:
- tag: title
content: Build a personal website
description: Utilize the Developer Platform to build a personal website for your portfolio or blog.

---

import { LearningPath } from "~/components"

<LearningPath file="personal-website" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Connect your Git provider to Pages
pcx_content_type: overview
sidebar:
order: 1
---

import { Render } from "~/components"

<Render file="get-started-git-connect-pages" product="pages" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Configure your deployment
pcx_content_type: overview
sidebar:
order: 2
---

import { Render } from "~/components"

<Render file="get-started-git-configure-deployment" product="pages" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Manage your site
pcx_content_type: overview
sidebar:
order: 3
---

import { Render } from "~/components"

<Render file="get-started-git-manage-site" product="pages" />
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Connect Git and Pages
pcx_content_type: overview
sidebar:
order: 3
---

## Objectives

By the end of this module, you will:

- Connect your Git provider to Pages
- Configure the deployment for your site
- Learn how to manage your site
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Website themes
pcx_content_type: overview
sidebar:
order: 4
---

If you are new to modifying the look and feel of a website, you can find a variety of free website themes online.

For example, [Astro](https://astro.build/), used by Cloudflare's Developer Documentation, has a list of free and paid [themes](https://astro.build/themes/) you can use to customize your website.
136 changes: 5 additions & 131 deletions src/content/docs/pages/get-started/git-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,144 +8,18 @@ description: Connect your Git provider to Pages.

---

import { Details } from "~/components"
import { Details, Render } from "~/components"

In this guide, you will get started with Cloudflare Pages, and deploy your first website to the Pages platform through Git integration.

## Connect your Git provider to Pages

Pages offers support for [GitHub](https://github.com/) and [GitLab](https://gitlab.com/). To create your first Pages project:

1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/) and select your account.
2. In Account Home, select **Workers & Pages**.
3. Select **Create application** > **Pages** > **Connect to Git**.

You will be prompted to sign in with your preferred Git provider. This allows Cloudflare Pages to deploy your projects, and update your PRs with [preview deployments](/pages/configuration/preview-deployments/).

:::note


Signing in with GitLab will grant Pages access to all repositories on your account. Additionally, if you are a part of a multi-user Cloudflare account, and you sign in with GitLab, other members will also have the ability to deploy your repositories to Pages.

If you are using GitLab, you must have the **Maintainer** role or higher on the repository to successfully deploy with Cloudflare Pages.


:::

### Select your GitHub repository

You can select a GitHub project from your personal account or an organization you have given Pages access to. This allows you to choose a GitHub repository to deploy using Pages. Both private and public repositories are supported.

### Select your GitLab repository

If using GitLab, you can select a project from your personal account or from a GitLab group you belong to. This allows you to choose a GitLab repository to deploy using Pages. Both private and public repositories are supported.
<Render file="get-started-git-connect-pages" product="pages" />

## Configure your deployment

Once you have selected a Git repository, select **Install & Authorize** and **Begin setup**. You can then customize your deployment in **Set up builds and deployments**.

Your **project name** will be used to generate your project's hostname. By default, this matches your Git project name.

**Production branch** indicates the branch that Cloudflare Pages should use to deploy the production version of your site. For most projects, this is the `main` or `master` branch. All other branches that are not your production branch will be used for [preview deployments](/pages/configuration/preview-deployments/).

:::note


You must have pushed at least one branch to your GitHub or GitLab project in order to select a **Production branch** from the dropdown menu.


:::

![Set up builds and deployments page with Project name and Production branch filled in](~/assets/images/pages/get-started/configuration.png)

### Configure your build settings

Depending on the framework, tool, or project you are deploying to Cloudflare Pages, you will need to specify the site's **build command** and **build output directory** to tell Cloudflare Pages how to deploy your site. The content of this directory is uploaded to Cloudflare Pages as your website's content.

:::caution[No framework required]


You do not need a framework to deploy with Cloudflare Pages. You can continue with the Get started guide without choosing a framework, and refer to [Deploy your site](/pages/framework-guides/deploy-anything/) for more information on deploying your site without a framework.


:::

The dashboard provides a number of framework-specific presets. These presets provide the default build command and build output directory values for the selected framework. If you are unsure what the correct values are for this section, refer to [Build configuration](/pages/configuration/build-configuration/). If you do not need a build step, leave the **Build command** field blank.

![Build setting fields that need to be filled in](~/assets/images/pages/get-started/build-settings.png)

Cloudflare Pages begins by working from your repository's root directory. The entire build pipeline, including the installation steps, will begin from this location. If you would like to change this, specify a new root directory location through the **Root directory (advanced)** > **Path** field.

![Root directory field to be filled in](~/assets/images/pages/get-started/root-directory.png)


<Details header="Understanding your build configuration">

The build command is provided by your framework. For example, the Gatsby framework uses `gatsby build` as its build command. When you are working without a framework, leave the **Build command** field blank.

The build output directory is generated from the build command. Each [framework](/pages/configuration/build-configuration/#framework-presets) has its own naming convention, for example, the build output directory is named `/public` for many frameworks.

The root directory is where your site's content lives. If not specified, Cloudflare assumes that your linked Git repository is the root directory. The root directory needs to be specified in cases like monorepos, where there may be multiple projects in one repository.

Refer to [Build configuration](/pages/configuration/build-configuration/) for more information.


</Details>

### Environment variables

Environment variables are a common way of providing configuration to your build workflow. While setting up your project, you can specify a number of key-value pairs as environment variables. These can be further customized once your project has finished building for the first time.

Refer to the [Hexo framework guide](/pages/framework-guides/deploy-a-hexo-site/#using-a-specific-nodejs-version) for more information on how to set up a Node.js version environment variable.

After you have chosen your *Framework preset* or left this field blank if you are working without a framework, configured **Root directory (advanced)**, and customized your **Environment variables (optional)**, you are ready to deploy.

## Your first deploy

After you have finished setting your build configuration, select **Save and Deploy**. Your project build logs will output as Cloudflare Pages installs your project dependencies, builds the project, and deploys it to Cloudflare's global network.

![Deployment details in the Cloudflare dashboard](~/assets/images/pages/get-started/deploy-log.png)

When your project has finished deploying, you will receive a unique URL to view your deployed site.

:::caution[DNS errors]


If you encounter a DNS error after visiting your site after your first deploy, this might be because the DNS has not had time to propagate. To solve the error, wait for the DNS to propagate, or try another device or network to resolve the error.


:::

## Manage your site

After your first deploy, select **Continue to project** to see your project's configuration in the Cloudflare Pages dashboard. On this page, you can see your project's current deployment status, the production URL and associated commit, and all past deployments.

![Site dashboard displaying your environments and deployments](~/assets/images/pages/get-started/site-dashboard.png)

### Delete a project

To delete your Pages project:

1. Go back to the **Account Home** or use the drop-down menu at the top of the dashboard.
2. Select **Workers & Pages**.
3. Select your Pages project > **Settings** > **Delete project**.

:::caution


For projects with a custom domain, you must first delete the CNAME record associated with your Pages project. Failure to do so may leave the DNS records active, causing your domain to point to a Pages project that no longer exists. Refer to [Deleting a custom domain](/pages/configuration/custom-domains/#delete-a-custom-domain) for instructions.

For projects without a custom domain (any project on a `*.pages.dev` subdomain), your project can be deleted in the project's settings.


:::

## Advanced project settings

In the **Settings** section, you can configure advanced settings, such as changing your project name, updating your Git configuration, or updating your build command, build directory or environment variables.
<Render file="get-started-git-configure-deployment" product="pages" />

## Related resources
## Manage site

* Set up a [custom domain for your Pages project](/pages/configuration/custom-domains/).
* Enable [Cloudflare Web Analytics](/pages/how-to/web-analytics/).
* Set up Access policies to [manage who can view your deployment previews](/pages/configuration/preview-deployments/#customize-preview-deployments-access).
<Render file="get-started-git-manage-site" product="pages" />
Loading
Loading