Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
95 lines
2.5 KiB
Plaintext
95 lines
2.5 KiB
Plaintext
---
|
|
title: '`next/image` Un-configured localPatterns'
|
|
---
|
|
|
|
## Why This Error Occurred
|
|
|
|
One of your pages that leverages the `next/image` component, passed a `src` value that uses a local path that isn't allowed by the `images.localPatterns` configuration in `next.config.js`.
|
|
|
|
Each part of the `src` value is matched against your `images.localPatterns` definitions:
|
|
|
|
- **Pathname**: The path must be covered by your glob pattern, e.g. `/**` or `/assets/**`. Single `*` matches a single path segment, while double `**` matches any number of path segments.
|
|
- **Search**: If specified in a pattern, it must match the full search string exactly (including the leading `?`). Globs are not supported for search.
|
|
|
|
If any of these differ from the actual `src`, the image will be rejected.
|
|
|
|
Common pitfalls that cause this error:
|
|
|
|
- A too-narrow pathname pattern (e.g. `/assets/` instead of `/assets/**`).
|
|
- Setting `search: ''` when your images include query strings like `?v=123` or `?t=timestamp`. An empty string means only URLs **without** query strings are allowed.
|
|
- Forgetting that pathname patterns are case-sensitive and must match exactly.
|
|
|
|
See the [Local Patterns](/docs/pages/api-reference/components/image#localpatterns) reference for details.
|
|
|
|
## Possible Ways to Fix It
|
|
|
|
Add the pathname to the `images.localPatterns` config in `next.config.js`:
|
|
|
|
```js filename="next.config.js"
|
|
module.exports = {
|
|
images: {
|
|
localPatterns: [
|
|
{
|
|
pathname: '/assets/**',
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
### Any search params (default)
|
|
|
|
To allow any search params, omit the `search` key:
|
|
|
|
```js filename="next.config.js"
|
|
module.exports = {
|
|
images: {
|
|
localPatterns: [
|
|
{
|
|
pathname: '/api/images/**',
|
|
// search is omitted, so ?v=123, ?t=456, or no query string are all allowed
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
### With specific search params
|
|
|
|
To allow only a specific search param value:
|
|
|
|
```js filename="next.config.js"
|
|
module.exports = {
|
|
images: {
|
|
localPatterns: [
|
|
{
|
|
pathname: '/assets/**',
|
|
search: '?v=1',
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
### No search params
|
|
|
|
To disallow query strings entirely, use an empty string:
|
|
|
|
```js filename="next.config.js"
|
|
module.exports = {
|
|
images: {
|
|
localPatterns: [
|
|
{
|
|
pathname: '/assets/**',
|
|
search: '',
|
|
},
|
|
],
|
|
},
|
|
}
|
|
```
|
|
|
|
## Useful Links
|
|
|
|
- [Image Optimization Documentation](/docs/pages/api-reference/components/image)
|
|
- [Local Patterns Documentation](/docs/pages/api-reference/components/image#localpatterns)
|