diff --git a/pages/docs/deploy/vercel.mdx b/pages/docs/deploy/vercel.mdx index 1b5a87fab..d0b5f692a 100644 --- a/pages/docs/deploy/vercel.mdx +++ b/pages/docs/deploy/vercel.mdx @@ -29,6 +29,29 @@ Installing [Inngest's official Vercel integraiton](https://vercel.com/integratio After you're installed, every new deploy to Vercel will update functions in [the Inngest dashboard](https://app.inngest.com/functions) within a few seconds! +## Bypassing Deployment Protection + +If you have Vercel's [Deployment Protection feature](https://vercel.com/docs/security/deployment-protection) enabled, _by default_, Inngest will not be able to send HTTP requests to your application's preview environments. To enable this, you will need to leverage Vercel's "[Protection Bypass for Automation](https://vercel.com/docs/security/deployment-protection#protection-bypass-for-automation)" feature. Access to this feature may be dependent on the Vercel plan that you're paying for (please see docs linked above). Here's how to set it up: + +1. Enable "Protection Bypass for Automation" on your Vercel project +2. Copy your secret +3. Goto [the Vercel integration settings page in the Inngest dashboard](https://app.inngest.com/settings/integrations/vercel) +4. For each project that you would like to enable this for, append the secret as a query string parameter to your Inngest serve route. e.g. `/api/inngest?x-vercel-protection-bypass=XYZ...` (see below). Inngest will now use this parameter to communicate with your application to bypass the deployment protection. +5. Trigger a re-deploy of your preview environment(s) (this re-deploys the functions to Inngest) + +A Vercel protection bypass secret appended as a query string in the Inngest dashboard + + + ⚠️ Warning - This URL is stored in the Inngest database as a plaintext value, so the bypass protection secret is not encrypted at rest in our database. In the future, we plan to store this value in a separate encrypted location. + + --- ### Manually registering functions diff --git a/public/assets/docs/deploy/vercel-protection-bypass.png b/public/assets/docs/deploy/vercel-protection-bypass.png new file mode 100644 index 000000000..d871669f2 Binary files /dev/null and b/public/assets/docs/deploy/vercel-protection-bypass.png differ