Matthew Phillips 6fd161d769

Add the output option (#4015 )

* Start of work on astroConfig.mode === 'server'

* Add tests and more

* adapter -> deploy in some places

* Add fallback for `adapter` config

* Update more tests

* Update image tests

* Fix clientAddress test

* Updates based on PR review

* Add a changeset

* Update integrations tests + readme

* Oops

* Remove old option

* Rename `mode` to `output`

* Update Node adapter test

* Update test

* fred pass

* fred pass

* fred pass

* fix test

Co-authored-by: Fred K. Schott <fkschott@gmail.com>

2022-07-25 00:18:02 -04:00

3.5 KiB

Raw Blame History

@astrojs/vercel

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

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

First, install the @astrojs/vercel package using your package manager. If you're using npm or aren't sure, run this in the terminal:

npm install @astrojs/vercel

Then, install this adapter in your astro.config.* file using the deploy property (note the import from @astrojs/vercel/serverless - see targets).

astro.config.mjs

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

This adapter does not expose any configuration options.

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-threads 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.

3.5 KiB Raw Blame History