Skip to content

Latest commit

 

History

History

vercel-protection-bypass

@sanity/vercel-protection-bypass

npm stat npm version gzip size size

npm install @sanity/vercel-protection-bypass

This package is used together with sanity/presentation to configure it to work with Vercel's Deployment Protection feature. The tool is only needed for setup, once it's configured you can safely uninstall it.

Add the tool your sanity.config.ts:

// ./sanity.config.ts
import {vercelProtectionBypassTool} from '@sanity/vercel-protection-bypass'
import {defineConfig} from 'sanity'
import {presentationTool} from 'sanity/presentation'

export default defineConfig({
  // ... other options
  plugins: [
    // ... other plugins
    presentationTool({
      previewUrl: {
        // @TODO change to the URL of the application, or `location.origin` if it's an embedded Studio
        origin: 'http://localhost:3000',
        previewMode: {
          enable: '/api/draft',
        },
      },
    }),
    vercelProtectionBypassTool(),
  ],
})

You should see a new Vercel Protection Bypass tab in the Studio's settings. Click it and follow the instructions to set up the tool.