| title | description | i18nReady |
|---|---|---|
On-demand Rendering |
Generate server-rendered pages and routes on demand with an adapter. |
true |
import PackageManagerTabs from '/components/tabs/PackageManagerTabs.astro';
import { Steps } from '@astrojs/starlight/components';
import RecipeLinks from '/components/RecipeLinks.astro';
import IntegrationsNav from '/components/IntegrationsNav.astro';
import ReadMore from '/components/ReadMore.astro';
Your Astro project code must be rendered to HTML in order to be displayed on the web.
By default, Astro pages, routes, and API endpoints will be pre-rendered at build time as static pages. However, you can choose to render some or all of your routes on demand by a server when a route is requested.
On-demand rendered pages and routes are generated per visit, and can be customized for each viewer. For example, a page rendered on demand can show a logged-in user their account information or display freshly updated data without requiring a full-site rebuild. On-demand rendering on the server at request time is also known as server-side rendering (SSR).
By default, your entire Astro site will be prerendered, and static HTML pages will be sent to the browser. However, you may opt out of prerendering on any routes that require server rendering, for example, a page that checks for cookies and displays personalized content.
First, add an adapter integration for your server runtime to enable on-demand server rendering in your Astro project.
Then, add export const prerender = false at the top of the individual page or endpoint you want to render on demand. The rest of your site will remain a static site:
---
export const prerender = false
---
<html>
<!--
This content will be server-rendered on demand!
Just add an adapter integration for a server runtime!
All other pages are statically-generated at build time!
-->
<html>The following example shows opting out of prerendering in order to display a random number each time the endpoint is hit:
export const prerender = false;
export async function GET() {
let number = Math.random();
return new Response(
JSON.stringify({
number,
message: `Here's a random number: ${number}`,
}),
);
}For a highly dynamic app, after adding an adapter, set your build output configuration to output: 'server' to server-render all your pages by default. This is the equivalent of opting out of prerendering on every page.
Then, if needed, you can choose to prerender any individual pages that do not require a server to execute, such as a privacy policy or about page.
---
export const prerender = true
---
<html>
<!--
`output: 'server'` is configured, but this page is static!
The rest of my site is rendered on demand!
-->
<html>Add export const prerender = true to any page or route to prerender a static page or endpoint:
export const prerender = true;
export async function GET() {
return new Response(
JSON.stringify({
message: `This is my static endpoint`,
}),
);
}:::tip Start with the default static mode until you are sure that most or all of your pages will be rendered on demand! This ensures that your site is as performant as possible, not relying on a server function to render static content.
The 'server' output mode does not bring any additional functionality and is only for convenience. It only switches the default page behaviour so you can avoid needing to opt out of prerendering manually on the majority of your routes.
:::
See more about the output setting in the configuration reference.
To render any of your pages on demand, for any output mode, you need to add an adapter.
Astro maintains official adapters for Node.js, Netlify, Vercel, and Cloudflare. You can find both official and community adapters in our integrations directory. Choose the one that corresponds to your deployment environment.
Each adapter allows Astro to output a script that runs your project on a specific runtime: the environment that runs code on the server to generate pages when they are requested (e.g. Netlify, Cloudflare).
You can add any of the official adapter integrations maintained by Astro 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.
For example, to install the Netlify adapter, run:
```shell npx astro add netlify ``` ```shell pnpm astro add netlify ``` ```shell yarn astro add netlify ```You can also add an adapter manually by installing the NPM package (e.g. @astrojs/netlify) and updating astro.config.mjs yourself.
Note that different adapters may have different configuration settings. Read each adapter's documentation, and apply any necessary config options to your chosen adapter in astro.config.mjs
With HTML streaming, a document is broken up into chunks, sent over the network in order, and rendered on the page in that order. Astro uses HTML streaming in on-demand rendering to send each component to the browser as it renders them. This makes sure the user sees your HTML as fast as possible, although network conditions can cause large documents to be downloaded slowly, and waiting for data fetches can block page rendering.
<RecipeLinks slugs={["en/recipes/streaming-improve-page-performance"]}/>
:::caution Features that modify the Response headers are only available at the page level. (You can't use them inside of components, including layout components.) By the time Astro runs your component code, it has already sent the Response headers and they cannot be modified.
:::
A page or API endpoint rendered on demand can check, set, get, and delete cookies.
The example below updates the value of a cookie for a page view counter:
---
export const prerender = false; // Not needed in 'server' mode
let counter = 0
if (Astro.cookies.has('counter')) {
const cookie = Astro.cookies.get('counter')
const value = cookie?.number()
if (value !== undefined && !isNaN(value)) counter = value + 1
}
Astro.cookies.set('counter', String(counter))
---
<html>
<h1>Counter = {counter}</h1>
</html>See more details about Astro.cookies and the AstroCookie type in the API reference.
Astro.response is a standard ResponseInit object. It can be used to set the response status and headers.
The example below sets a response status and status text for a product page when the product does not exist:
---
export const prerender = false; // Not needed in 'server' mode
import { getProduct } from '../api';
const product = await getProduct(Astro.params.id);
// No product found
if (!product) {
Astro.response.status = 404;
Astro.response.statusText = 'Not found';
}
---
<html>
<!-- Page here... -->
</html>You can set headers using the Astro.response.headers object:
---
export const prerender = false; // Not needed in 'server' mode
Astro.response.headers.set('Cache-Control', 'public, max-age=3600');
---
<html>
<!-- Page here... -->
</html>You can also return a Response object directly from any page using on-demand rendering.
The example below returns a 404 on a dynamic page after looking up an ID in the database:
---
export const prerender = false; // Not needed in 'server' mode
import { getProduct } from '../api';
const product = await getProduct(Astro.params.id);
// No product found
if (!product) {
return new Response(null, {
status: 404,
statusText: 'Not found'
});
}
---
<html>
<!-- Page here... -->
</html>Instead of returning a Response object, you can also redirect the user to another page using Astro.redirect:
---
export const prerender = false; // Not needed in 'server' mode
import { getProduct } from '../api';
const product = await getProduct(Astro.params.id);
// No product found
if (!product) {
return Astro.redirect('/404', 404);
}
---
<html>
<!-- Page here... -->
</html>Astro.request is a standard Request object. It can be used to get the url, headers, method, and even the body of the request.
You can access additional information from this object for pages that are not statically generated.
The headers for the request are available on Astro.request.headers. This works like the browser's Request.headers. It is a Headers object where you can retrieve headers such as the cookie.
---
export const prerender = false; // Not needed in 'server' mode
const cookie = Astro.request.headers.get('cookie');
// ...
---
<html>
<!-- Page here... -->
</html>The HTTP method used in the request is available as Astro.request.method. This works like the browser's Request.method. It returns the string representation of the HTTP method used in the request.
---
export const prerender = false; // Not needed in 'server' mode
console.log(Astro.request.method) // GET (when navigated to in the browser)
---See more details about Astro.request in the API reference.
A server endpoint, also known as an API route, is a special function exported from a .js or .ts file within the src/pages/ folder. A powerful feature of server-side rendering on demand, API routes are able to securely execute code on the server.
The function takes an endpoint context and returns a Response.
To learn more, see our Endpoints Guide.