astro/packages/integrations/vercel/README.md

@astrojs/vercel

Deploy your server-side rendered (SSR) Astro app to Vercel.

Use this integration in your Astro configuration file:

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

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

When you build your project, Astro will know to use the .vercel/output folder format that Vercel expects.

Deploying

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:

ENABLE_VC_BUILD=1 astro build
vercel deploy --prebuilt

Requirements

Vercel's Build Output API must be enabled. You must enable it yourself by setting the environment variable: ENABLE_VC_BUILD=1.

// vercel.json
{
  "build": {
    "env": {
      "ENABLE_VC_BUILD": "1"
    }
  }
}

Learn more about setting enviroment variables in Vercel.

Targets

You can deploy to different targes:

• edge: SSR inside a 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 — they 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';

Node.js version

When deploying to serverless you can choose what version of Node.js you want to target: 12.x, 14.x or 16.x (default).

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

export default defineConfig({
	adapter: vercel({ nodeVersion: '14.x' })
});

Limitations

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.