Skip to content

Update preview security #8588#2102

Open
alhambrav wants to merge 2 commits into
craftercms:masterfrom
alhambrav:update-preview-security
Open

Update preview security #8588#2102
alhambrav wants to merge 2 commits into
craftercms:masterfrom
alhambrav:update-preview-security

Conversation

@alhambrav

Copy link
Copy Markdown
Member

Ticket reference or full description of what's in the PR

Update Preview Mode with note on how to disable preview security craftercms/craftercms#8588

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 873a03a9-397a-4b3d-a204-1d76ad9ea732

📥 Commits

Reviewing files that changed from the base of the PR and between 65be3d4 and 998eb13.

📒 Files selected for processing (3)
  • source/_static/api/engine.html
  • source/reference/modules/engine.rst
  • source/reference/modules/studio.rst

Summary by CodeRabbit

  • Documentation
    • Added clarifications to documentation regarding preview mode security configuration, explaining how to disable security for preview server and delivery APIs.

Walkthrough

This PR adds documentation clarifications about the preview mode security configuration option (crafter.security.preview.enabled) in two related documentation sections. The Engine documentation now explicitly states that disabling this property turns off the preview server security filter, and the Studio documentation explains how to disable security for delivery APIs in preview mode with a cross-reference to the Engine docs.

Changes

Preview Mode Security Configuration Documentation

Layer / File(s) Summary
Preview security configuration across Engine and Studio docs
source/reference/modules/engine.rst, source/reference/modules/studio.rst
Added notes in the Engine Preview Mode section clarifying that setting crafter.security.preview.enabled to false disables the preview server security filter, and in the Studio Preview Token section explaining how to disable preview delivery API security with a link to the Engine documentation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • sumerjabri
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the main change: updating preview security documentation with references to issue #8588.
Description check ✅ Passed The description follows the required template with ticket reference and includes a clear explanation linking to the related issue.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@alhambrav alhambrav marked this pull request as ready for review June 8, 2026 13:39
@alhambrav alhambrav requested a review from sumerjabri June 8, 2026 13:39
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.

1 participant