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

Update docs with details for cached images #18399

Merged
merged 4 commits into from
Oct 28, 2020
Merged

Update docs with details for cached images #18399

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
df9b4ee
Update docs with details for cached images
styfle Oct 28, 2020
8490528
Disclose this is default loader only
styfle Oct 28, 2020
61b7602
Mention `deviceSizes`
styfle Oct 28, 2020
8ff0824
Fix typos
styfle Oct 28, 2020
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
12 changes: 11 additions & 1 deletion docs/basic-features/image-optimization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,11 +122,21 @@ module.exports = {
The following Image Optimization cloud providers are supported:

- When using `next start` or a custom server image optimization works automatically.
- [Vercel](https://vercel.com): Works automatically when you deploy on Vercel
- [Vercel](https://vercel.com): Works automatically when you deploy on Vercel, no configuration necessary.
- [Imgix](https://www.imgix.com): `loader: 'imgix'`
- [Cloudinary](https://cloudinary.com): `loader: 'cloudinary'`
- [Akamai](https://www.akamai.com): `loader: 'akamai'`

## Caching

The following describes the caching algorithm for the default [loader](#loader). For all other loaders, please refer to your cloud provider documentation.

Images are optimzed dynamically when requested and stored in the `<distDir>/cache/images` directory. The optimized image file will be served for subsequent requests until the expiration is reached. When a request is made that matches a cached but expired file, the cached file is deleted before generating a new optimize image and caching the new file.

The expiration (or rather Max Age) is defined by the upstream server's `Cache-Control` header.

If `s-maxage` is found in `Cache-Control`, it is used. If no `s-maxage` is found, then `max-age` is used. If no `max-age` is found, then 60 seconds is used.

## Related

For more information on what to do next, we recommend the following sections:
Expand Down