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

Jump to bottom

[docs] Update docs about Cache-Control default headers. #35336

Merged
merged 4 commits into from Mar 16, 2022
Merged

[docs] Update docs about Cache-Control default headers. #35336

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
004de91
Update docs about Cache-Control default headers.
Gomurmamma Mar 15, 2022
5189e8a
Update docs: Override the default in case of gSSP
Gomurmamma Mar 15, 2022
70ac82e
Apply suggestions from code review
balazsorban44 Mar 16, 2022
3f76c1a
Update going-to-production.md
balazsorban44 Mar 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/going-to-production.md
View file
Open in desktop
Expand Up @@ -68,6 +68,13 @@ export async function getServerSideProps({ req, res }) {
}
}
```
By default, `Cache-Control` headers will be set differently depending on how your page fetches data.

If the page is using `getServerSideProps` or `getInitialProps`, then it will use the default `Cache-Control` header configured by `next start` in order to prevent accidental caching of responses that cannot be cached.

If the page is using `getStaticProps` or automatic static optimization, then it will have s-maxage=REVALIDATE_SECONDS, stale-while-revalidate or if revalidate is not used s-maxage=31536000, stale-while-revalidate.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The stale-while-revalidate header is not set for pages that are automatically statically optimized, only pages that use getStaticProps and return a revalidate value.


If you want a different Cache-Control while using SSR you can use res.setHeader('Cache-Control', 'value_you_prefer').
balazsorban44 marked this conversation as resolved.
Show resolved Hide resolved

> **Note:** Your deployment provider must support edge caching for dynamic responses. If you are self-hosting, you will need to add this logic to the edge yourself using a key/value store. If you are using Vercel, [edge caching works without configuration](https://vercel.com/docs/edge-network/caching).

Expand Down