History

Chris Swithinbank bf5d1cc1e7 More integration README fixes (#3885 ) * Integration README fixes * More tweaks (mostly code backticks for filenames) * Update changeset * Few more tweaks * Make sure code blocks all have a code language * Use URLs of new docs pages for package homepage * One more stray `<br>` 👢 * Standardise to `sh` instead of `shell`		2022-07-11 21:10:34 +02:00
..
src	Adding an option to disable HTTP streaming (#3777 )	2022-07-01 02:29:59 +00:00
CHANGELOG.md	[ci] release (#3850 )	2022-07-08 20:54:39 -04:00
package.json	More integration README fixes (#3885 )	2022-07-11 21:10:34 +02:00
README.md	More integration README fixes (#3885 )	2022-07-11 21:10:34 +02:00
tsconfig.json	feat: add SSR adaptor for cloudflare pages functions (#3600 )	2022-06-16 10:12:25 -04:00

README.md

@astrojs/cloudflare

An SSR adapter for use with Cloudflare Pages Functions targets. Write your code in Astro/Node and deploy to Cloudflare Pages.

In your astro.config.mjs use:

import { defineConfig } from 'astro/config';
import cloudflare from '@astrojs/cloudflare';

export default defineConfig({
  adapter: cloudflare()
});

Enabling Preview

In order for preview to work you must install wrangler

$ pnpm install wrangler --save-dev

It's then possible to update the preview script in your package.json to "preview": "wrangler pages dev ./dist"

Streams

Some integrations such as React rely on web streams. Currently Cloudflare Pages functions are in beta and don't support the streams_enable_constructors feature flag.

In order to work around this:

install the "web-streams-polyfill" package
add import "web-streams-polyfill/es2018"; to the top of the front matter of every page which requires streams, such as server rendering a React component.