-
Notifications
You must be signed in to change notification settings - Fork 29.3k
Docs: Add authentication note for external/internal image sources #83469
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.
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: Add authentication note for external/internal image sources #83469
Conversation
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
thanks for referencing my issue (#82703). |
Thank you for pointing that out.
I’d like to emphasize once again that this PR is meant to address issue #82610. |
Sorry, and thank you for pointing that out. I prefer the latter that explicitly mentions internal URLs, since the intention is to make the restrictions and behavior clearer to developers. Co-authored-by: Joseph <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! I pushed a couple suggestions 👍
Thank you for accepting my PR. |
Summary
This PR adds a note to the documentation clarifying the behavior when using external or internal URLs (API Routes) as image sources with Next.js Image Optimization.
This change addresses issue #82610.
Details
unoptimized
property should be considered to disable Image Optimization.Why
Users may be confused when trying to load images from endpoints that require authentication. This clarification helps developers understand the limitation and how to handle such cases.
References
resolves #82610