Deploy your Astro Site to Cloudflare Pages
यह कंटेंट अभी तक आपकी भाषा में उपलब्ध नहीं है।
You can deploy your Astro project on Cloudflare Pages, a platform for frontend developers to collaborate and deploy static (JAMstack) and SSR websites.
This guide includes:
- How to deploy through the Cloudflare Pages Dashboard
- How to deploy using Wrangler, the Cloudflare CLI
- How to deploy an SSR site using
@astrojs/cloudflare
Prerequisites
Section titled PrerequisitesTo get started, you will need:
- A Cloudflare account. If you don’t already have one, you can create a free Cloudflare account during the process.
- Your app code pushed to a GitHub or a GitLab repository.
How to deploy a site with Git
Section titled How to deploy a site with Git-
Set up a new project on Cloudflare Pages.
-
Push your code to your git repository (GitHub, GitLab).
-
Log in to the Cloudflare dashboard and select your account in Account Home > Pages.
-
Select Create a new Project and the Connect Git option.
-
Select the git project you want to deploy and click Begin setup
-
Use the following build settings:
- Framework preset:
Astro
- Build command:
npm run build
- Build output directory:
dist
- Framework preset:
-
Click the Save and Deploy button.
How to deploy a site using Wrangler
Section titled How to deploy a site using Wrangler-
Install Wrangler CLI.
-
Authenticate Wrangler with your Cloudflare account using
wrangler login
. -
Run your build command.
-
Deploy using
npx wrangler pages deploy dist
.
After your assets are uploaded, Wrangler will give you a preview URL to inspect your site. When you log into the Cloudflare Pages dashboard, you will see your new project.
Enabling Preview locally with Wrangler
Section titled Enabling Preview locally with WranglerFor the preview to work, you must install wrangler
It’s then possible to update the preview script to run wrangler
instead of Astro’s built-in preview command:
How to deploy an SSR site
Section titled How to deploy an SSR siteYou can build an Astro SSR site for deployment to Cloudflare Pages using the @astrojs/cloudflare
adapter.
Follow the steps below to set up the adapter. You can then deploy using either of the approaches documented above.
Quick install
Section titled Quick installAdd the Cloudflare adapter to enable SSR in your Astro project with the following astro add
command. This will install the adapter and make the appropriate changes to your astro.config.mjs
file in one step.
Manual install
Section titled Manual installIf you prefer to install the adapter manually instead, complete the following two steps:
-
Add the
@astrojs/cloudflare
adapter to your project’s dependencies using your preferred package manager. If you’re using npm or aren’t sure, run this in the terminal: -
Add the following to your
astro.config.mjs
file:
Troubleshooting
Section titled TroubleshootingClient-side hydration
Section titled Client-side hydrationClient-side hydration may fail as a result of Cloudflare’s Auto Minify setting. If you see Hydration completed but contains mismatches
in the console, make sure to disable Auto Minify under Cloudflare settings.
Node.js runtime APIs
Section titled Node.js runtime APIsIf you are building a project that is using on-demand rendering with the Cloudflare SSR adapter and the server fails to build with an error message such as [Error] Could not resolve "XXXX. The package "XXXX" wasn't found on the file system but is built into node.
:
-
This means that a package or import you are using in the server-side environment is not compatible with the Cloudflare runtime APIs.
-
If you are directly importing a Node.js runtime API, please refer to the Astro documentation on Cloudflare’s Node.js compatibility for further steps on how to resolve this.
-
If you are importing a package that imports a Node.js runtime API, check with the author of the package to see if they support the
node:*
import syntax. If they do not, you may need to find an alternative package.