Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: explain about the conditional default metadataBase on vercel de… #65583

Merged
merged 3 commits into from
May 10, 2024
Merged

docs: explain about the conditional default metadataBase on vercel de… #65583

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
13c9690
docs: explain about the conditional default metadataBase on vercel de…
huozhi May 9, 2024
d50d572
Update docs/02-app/02-api-reference/04-functions/generate-metadata.mdx
huozhi May 10, 2024
be58d08
lint
huozhi May 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/02-app/02-api-reference/04-functions/generate-metadata.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,14 @@ export const metadata = {

If not configured, `metadataBase` has a **default value**.

- When [`VERCEL_PROJECT_PRODUCTION_URL`](https://vercel.com/docs/concepts/projects/environment-variables/system-environment-variables) or [`VERCEL_URL`](https://vercel.com/docs/concepts/projects/environment-variables/system-environment-variables) is detected, it will be used as the **default value**, otherwise it falls back to `http://localhost:${process.env.PORT || 3000}`. This allows Open Graph images to work on both preview and production deployments.
- When overriding the default, we recommend using environment variables to compute the URL. This allows configuring a URL for local development, staging, and production environments.
> On Vercel:
>
> - For production deployments, `VERCEL_PROJECT_PRODUCTION_URL` will be used.
> - For preview deployments, `VERCEL_BRANCH_URL` will take priority, and fallback to `VERCEL_URL` if it's not present.
>
> If these values are present they will be used as the **default value** of `metadataBase`, otherwise it falls back to `http://localhost:${process.env.PORT || 3000}`. This allows Open Graph images to work on both local build and Vercel preview and production deployments. When overriding the default, we recommend using environment variables to compute the URL. This allows configuring a URL for local development, staging, and production environments.
>
> See more details about these environment variables in the [System Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables/system-environment-variables) docs.

#### URL Composition

Expand Down