astro/packages/integrations/vercel/README.md

@astrojs/vercel

This adapter allows Astro to deploy your SSR site to Vercel.

Learn how to deploy your Astro site in our Vercel deployment guide.

• Why Astro Vercel
• Installation
• Usage
• Configuration
• Troubleshooting
• Contributing
• Changelog

Why Astro Vercel

If you're using Astro as a static site builder — its behavior out of the box — you don't need an adapter.

If you wish to use server-side rendering (SSR), Astro requires an adapter that matches your deployment runtime.

Vercel is a deployment platform that allows you to host your site by connecting directly to your GitHub repository. This adapter enhances the Astro build process to prepare your project for deployment through Vercel.

Installation

Add the Vercel 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.

# Using NPM
npx astro add vercel
# Using Yarn
yarn astro add vercel
# Using PNPM
pnpm astro add vercel

If you prefer to install the adapter manually instead, complete the following two steps:

1. Install the Vercel 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:

     npm install @astrojs/vercel
   

2. Add two new lines to your astro.config.mjs project configuration file.

   import { defineConfig } from 'astro/config';
   import vercel from '@astrojs/vercel/serverless';
   
   export default defineConfig({
     output: 'server',
     adapter: vercel(),
   });
   

Targets

You can deploy to different targets:

• edge: SSR inside an Edge function.
• serverless: SSR inside a Node.js function.
• static: generates a static website following Vercel's output formats, redirects, etc.

Note

: deploying to the Edge has its limitations. An edge function can't be more than 1 MB in size and they don't support native Node.js APIs, among others.

You can change where to target by changing the import:

import vercel from '@astrojs/vercel/edge';
import vercel from '@astrojs/vercel/serverless';
import vercel from '@astrojs/vercel/static';

Usage

📚 Read the full deployment guide here.

You can deploy by CLI (vercel deploy) or by connecting your new repo in the Vercel Dashboard. Alternatively, you can create a production build locally:

astro build
vercel deploy --prebuilt

Configuration

To configure this adapter, pass an object to the vercel() function call in astro.config.mjs:

includeFiles

Type: string[] Available for: Edge, Serverless

Use this property to force files to be bundled with your function. This is helpful when you notice missing files.

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

export default defineConfig({
  output: 'server',
  adapter: vercel({
    includeFiles: ['./my-data.json']
  })
});

Note

When building for the Edge, all the depencies get bundled in a single file to save space. No extra file will be bundled. So, if you need some file inside the function, you have to specify it in includeFiles.

excludeFiles

Type: string[] Available for: Serverless

Use this property to exclude any files from the bundling process that would otherwise be included.

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

export default defineConfig({
  output: 'server',
  adapter: vercel({
    excludeFiles: ['./src/some_big_file.jpg']
  })
});

Troubleshooting

A few known complex packages (example: puppeteer) do not support bundling and therefore will not work properly with this adapter. By default, Vercel doesn't include npm installed files & packages from your project's ./node_modules folder. To address this, the @astrojs/vercel adapter automatically bundles your final build output using esbuild.

For help, check out the #support channel on Discord. Our friendly Support Squad members are here to help!

Contributing

This package is maintained by Astro's Core team. You're welcome to submit an issue or PR!

Changelog

See CHANGELOG.md for a history of changes to this integration.