Deploying to Cloudflare Pages in Astro

Introduction

Deploying to Cloudflare Pages lets you put your Astro website online quickly and for free. It makes your site available to anyone on the internet.

You finished building an Astro website and want to share it with friends or customers.

You want a fast and secure place to host your static site without managing servers.

You want automatic updates when you change your website code in GitHub.

You want to use Cloudflare's global network to make your site load fast everywhere.

You want to try deploying a site without paying or complex setup.

Syntax

Astro

1. Push your Astro project to a GitHub repository.
2. Go to Cloudflare Pages dashboard.
3. Click 'Create a project' and connect your GitHub repo.
4. Set the build command to: npm run build
5. Set the build output directory to: dist
6. Click 'Save and Deploy'.

The npm run build command runs Astro's build process.

The dist folder is where Astro puts the finished website files.

Examples

This is the standard setup for Astro projects on Cloudflare Pages.

Astro

Build command: npm run build
Output directory: dist

You can also use astro build directly if you prefer.

Astro

Build command: astro build
Output directory: dist

Use this only if you changed Astro's output folder to public in your config.

Astro

Build command: npm run build
Output directory: public

Sample Program

This example shows the minimal setup for an Astro project ready to deploy on Cloudflare Pages. The build script runs astro build, which creates the dist folder. Cloudflare Pages uses this folder to serve your site.

Astro

/*
This is a simple Astro project setup for Cloudflare Pages deployment.
*/

// package.json scripts section
{
  "scripts": {
    "build": "astro build",
    "start": "astro dev"
  }
}

// astro.config.mjs
import { defineConfig } from 'astro/config';

export default defineConfig({
  output: 'static'
});

// After pushing this project to GitHub:
// 1. Go to Cloudflare Pages dashboard.
// 2. Connect your GitHub repo.
// 3. Set build command: npm run build
// 4. Set output directory: dist
// 5. Deploy.

Important Notes

Make sure your GitHub repo is public or connected properly to Cloudflare Pages.

Cloudflare Pages automatically redeploys your site when you push new code to the connected branch.

Use the Cloudflare Pages dashboard to see build logs and manage your site.

Summary

Deploying to Cloudflare Pages makes your Astro site live on the internet easily.

Push your code to GitHub, connect it in Cloudflare Pages, and set build/output settings.

Cloudflare Pages handles hosting and updates automatically for you.

Practice

1. What is the first step to deploy an Astro site to Cloudflare Pages?

easy

A. Push your Astro project code to a GitHub repository

B. Write a custom server script for Cloudflare

C. Install Cloudflare Pages CLI locally

D. Create a Docker container for the site

Solution

1. Step 1: Prepare your Astro project

   You need to have your Astro site code ready and pushed to a GitHub repository because Cloudflare Pages connects to GitHub to get your code.

2. Step 2: Connect GitHub repo to Cloudflare Pages

   Cloudflare Pages uses your GitHub repository to build and deploy your site automatically.

3. Final Answer:

   Push your Astro project code to a GitHub repository -> Option A

4. Quick Check:

   First step is pushing code to GitHub [OK]

Hint: Remember: Cloudflare Pages pulls from GitHub first [OK]

Common Mistakes:

• Trying to deploy without a GitHub repo
• Assuming local CLI is mandatory
• Thinking Docker is required

2. Which build command is typically used in Cloudflare Pages settings for an Astro project?

easy

A. astro dev

B. npm run start

C. npm run build

D. npm install

Solution

1. Step 1: Understand Astro build process

   Astro projects use npm run build to create the static files for deployment.

2. Step 2: Set build command in Cloudflare Pages

   Cloudflare Pages needs the build command to generate the site files; npm run build is the correct command.

3. Final Answer:

   npm run build -> Option C

4. Quick Check:

   Build command = npm run build [OK]

Hint: Build command for Astro is always npm run build [OK]

Common Mistakes:

• Using npm run start which runs a dev server
• Using astro dev which is for local development
• Confusing install with build

3. Given this Cloudflare Pages config snippet:

build:
  command: "npm run build"
  directory: "dist"

What will Cloudflare Pages do after you push your Astro site code?

medium

A. Run npm install and deploy files from node_modules

B. Run npm run build and deploy files from the dist folder

C. Ignore build and deploy all files in the repo

D. Run npm start and deploy files from the root folder

Solution

1. Step 1: Read the build command

   The config says to run npm run build, which builds the Astro site into static files.

2. Step 2: Check the output directory

   The directory dist is where Astro puts the built site files, so Cloudflare Pages deploys from there.

3. Final Answer:

   Run npm run build and deploy files from the dist folder -> Option B

4. Quick Check:

   Build command + output folder = deploy [OK]

Hint: Build command runs, output folder is deployed [OK]

Common Mistakes:

• Confusing npm start with build
• Deploying from wrong folder
• Thinking node_modules is deployed

4. You connected your GitHub repo to Cloudflare Pages but the deployment fails with "Build command not found" error. What is the likely cause?

medium

A. You pushed code to the wrong GitHub branch

B. You used the wrong Cloudflare account

C. You did not enable GitHub Actions

D. You forgot to add a build script in package.json

Solution

1. Step 1: Understand the error message

   "Build command not found" means Cloudflare tried to run the build command but it does not exist in your project.

2. Step 2: Check package.json scripts

   The build command must be defined in the scripts section of package.json, usually as "build": "astro build" or similar.

3. Final Answer:

   You forgot to add a build script in package.json -> Option D

4. Quick Check:

   Missing build script causes build command error [OK]

Hint: Check package.json scripts for build command [OK]

Common Mistakes:

• Assuming branch or account causes build command error
• Thinking GitHub Actions must be enabled manually
• Ignoring package.json scripts

5. You want to deploy an Astro site with environment variables on Cloudflare Pages. Which step is necessary to ensure your variables are available during build?

hard

A. Add environment variables in Cloudflare Pages dashboard under Settings > Environment Variables

B. Include variables in a .env file and push it to GitHub

C. Hardcode variables directly in your Astro source code

D. Set variables only in your local machine before pushing

Solution

1. Step 1: Understand environment variable usage in Cloudflare Pages

   Cloudflare Pages requires environment variables to be set in its dashboard to inject them during build securely.

2. Step 2: Avoid pushing .env files with secrets

   For security, do not push .env files with secrets to GitHub; instead, configure variables in Cloudflare Pages settings.

3. Final Answer:

   Add environment variables in Cloudflare Pages dashboard under Settings > Environment Variables -> Option A

4. Quick Check:

   Set env vars in Cloudflare dashboard for build [OK]

Hint: Set env vars in Cloudflare dashboard, not in repo [OK]

Common Mistakes:

• Pushing .env files with secrets publicly
• Hardcoding sensitive info in code
• Assuming local env vars affect cloud build