Skip to content

[Docs] Refresh and clarify remote thumbnail generation guide#2280

Open
Copilot wants to merge 6 commits into
mainfrom
copilot/update-remote-thumbnail-generation
Open

[Docs] Refresh and clarify remote thumbnail generation guide#2280
Copilot wants to merge 6 commits into
mainfrom
copilot/update-remote-thumbnail-generation

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 8, 2026

Summary

Expands the Remote Thumbnail Generation guide with the technical detail developers need when enabling the feature, based on a full read of the current implementation in shopware/shopware.

What changed

  • Configuration table — added types and defaults for both remote_thumbnails.* keys, made enable: false default explicit.
  • Pattern variables — clarified that {mediaUrl} resolves from shopware.filesystem.public and is replaced with an empty string for media whose path is already an absolute URL. Noted
    {mediaUpdatedAt} was added in 6.6.5.0.
  • Private media warning — documented that private media is intentionally excluded from remote URL generation and keeps using its signed local URL.
  • New "Behavior when enabled" section — documents what the flag actually short-circuits: ThumbnailService throws MEDIA_THUMBNAIL_GENERATION_DISABLED,
    GenerateThumbnailsHandler/MediaIndexer early-return, media:generate-thumbnails aborts, FileSaver skips dispatch and rename, MediaDeletionSubscriber skips thumbnail rows, MediaUrlLoader
    delegates to RemoteThumbnailLoader. Plus a warning that synthesized MediaThumbnailEntity IDs are random per request and not persisted.
  • New "Cleaning up local thumbnails" section — documents bin/console media:delete-local-thumbnails (added 6.6.6.0) for migrating an existing shop.
  • New "Extending the URL generation" section — documents the ResolveRemoteThumbnailUrlExtension hook (remote_thumbnail_url.resolve, since 6.7.1.0; supports returning null to skip a
    thumbnail since 6.7.3.0).
  • Fastly section expanded — added soft_purge and max_parallel_invalidations to the example config; added a config table; clarified that api_key being non-empty is the on/off switch (no
    separate enabled flag); described the request shape and failure handling; added an info box disambiguating this media-cache node from shopware.http_cache.reverse_proxy.fastly, with a
    cross-link to the reverse-HTTP-cache guide.

Agent-Logs-Url: https://github.com/shopware/docs/sessions/9a002983-5211-4a0e-ba94-8e34b9b1e3f4

Co-authored-by: MartinKrzykawski <64466485+MartinKrzykawski@users.noreply.github.com>
Copilot AI changed the title [WIP] Update and validate Remote Thumbnail Generation documentation [Docs] Refresh and clarify remote thumbnail generation guide May 8, 2026
@MartinKrzykawski Martin Krzykawski (MartinKrzykawski) marked this pull request as ready for review May 8, 2026 11:37
@MartinKrzykawski Martin Krzykawski (MartinKrzykawski) requested review from Copilot and removed request for Copilot May 8, 2026 11:37
@MartinKrzykawski Martin Krzykawski (MartinKrzykawski) force-pushed the copilot/update-remote-thumbnail-generation branch from a00f9f9 to 14d3dd4 Compare May 8, 2026 12:16
Copilot AI review requested due to automatic review settings May 8, 2026 12:16
Copilot AI review requested due to automatic review settings May 11, 2026 12:26
Copy link
Copy Markdown
Contributor

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Shopware developer documentation for Remote Thumbnail Generation to better reflect real runtime behavior, version availability, and operational considerations when switching from local thumbnail generation to remote/CDN-driven URLs.

Changes:

  • Expanded configuration documentation with typed/defaulted config tables and clarified pattern variable behavior/versioning.
  • Added new sections documenting what Shopware short-circuits when the feature is enabled, plus migration guidance for cleaning up existing local thumbnails.
  • Significantly expanded the Fastly invalidation section (config options, activation behavior, and a cross-link clarifying the difference vs reverse-proxy Fastly config).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread guides/plugins/plugins/content/media/remote-thumbnail-generation.md Outdated
Comment thread guides/plugins/plugins/content/media/remote-thumbnail-generation.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Evaluate and Update "Remote Thumbnail Generation" article

6 participants