-
Notifications
You must be signed in to change notification settings - Fork 7
Document settings.iframe.allowed-parent-origins in site settings and em… #7016
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
Open
fern-api
wants to merge
1
commit into
main
Choose a base branch
from
2026-09-18-fern-ai-1fb7a4-d9f1c6c5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+42
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -752,6 +752,9 @@ settings: | |
| use-javascript-as-typescript: false | ||
| folder-title-source: frontmatter | ||
| substitute-env-vars: true | ||
| iframe: | ||
| allowed-parent-origins: | ||
| - https://app.example.com | ||
| ``` | ||
|
|
||
| <ParamField path="settings.search-text" type="string" required={false} default="Search" toc={true}> | ||
|
|
@@ -845,6 +848,29 @@ settings: | |
| </Note> | ||
| </ParamField> | ||
|
|
||
| <ParamField path="settings.iframe" type="object" required={false} toc={true}> | ||
| Configure which third-party origins are allowed to embed your docs in an iframe. By default, Fern sets a `Content-Security-Policy: frame-ancestors 'self' https://*.buildwithfern.com` header on every page. Use `?embedded=true` to omit `frame-ancestors` entirely and allow any origin to frame the page. | ||
|
|
||
| <Indent> | ||
| <ParamField path="settings.iframe.allowed-parent-origins" type="list of strings" required={false} toc={true}> | ||
| A list of origins to append to the `Content-Security-Policy: frame-ancestors` directive, allowing those origins to embed your docs in an iframe. Each entry must be a valid CSP host source of the form `scheme://host[:port]` (e.g. `https://app.example.com`, `https://*.example.com`). Bare wildcards (`*`), keyword sources (`'none'`, `'self'`), scheme-only sources (`https:`), and entries with paths are rejected. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶 |
||
|
|
||
| ```yaml docs.yml | ||
| settings: | ||
| iframe: | ||
| allowed-parent-origins: | ||
| - https://app.trumpet.app | ||
| - https://*.example.com | ||
| ``` | ||
|
|
||
| This produces a `Content-Security-Policy` header with: | ||
| ``` | ||
| frame-ancestors 'self' https://*.buildwithfern.com https://app.trumpet.app https://*.example.com | ||
| ``` | ||
| </ParamField> | ||
| </Indent> | ||
| </ParamField> | ||
|
|
||
| ## Page actions configuration | ||
|
|
||
| Configure the page action buttons that appear throughout your documentation. `page-actions.options` holds two kinds of actions: built-in actions you toggle on or off with a boolean, and configurable actions — the [Install skills action](#install-skills-action) and [custom page actions](#custom-page-actions) — that you define with their own settings. Set `page-actions.default` to choose which action shows first. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
📝 [vale] <FernStyles.Acronyms> reported by reviewdog 🐶
'CSP' has no definition.