Skip to content

DOC-3506 - Add firewall whitelist instructions to AI and Doc Converters documentation#4141

Open
kemister85 wants to merge 4 commits into
tinymce/8from
hotfix/8/DOC-3506
Open

DOC-3506 - Add firewall whitelist instructions to AI and Doc Converters documentation#4141
kemister85 wants to merge 4 commits into
tinymce/8from
hotfix/8/DOC-3506

Conversation

@kemister85
Copy link
Copy Markdown
Contributor

@kemister85 kemister85 commented May 14, 2026

Ticket: DOC-3506

Site:

Changes:

  • Added a new "Firewall and proxy allowlisting" section to the CSP page (tinymce-and-csp.adoc) as a single source of truth, documenting the *.tiny.cloud wildcard domain, individual service subdomains, and required HTTP headers (tiny-api-key, tinymce-api-key).
  • Created a reusable admonition partial (admon-cloud-firewall.adoc) for cross-referencing the firewall guidance from plugin pages.
  • Added the firewall admonition to the TinyMCE AI (tinymceai.adoc), Import from Word (importword.adoc), Export to Word (exportword.adoc), and Export to PDF (exportpdf.adoc) plugin pages, inside their cloud setup sections.
  • Updated the forward proxy configuration sections in editor-and-features.adoc and features-only.adoc to use the *.tiny.cloud wildcard domain instead of listing only three specific service URLs, and added a cross-reference to the CSP page.

Pre-checks:

  • Branch is correctly prefixed:

  • Hotfix: hotfix/8/DOC-3506

  • modules/ROOT/nav.adoc has been updated (if applicable). N/A, no new pages added.

  • Files have been included where required (if applicable).

  • Files removed have been deleted, not just excluded from the build (if applicable). N/A, no files removed.

  • Files added for New product features include a release note entry. N/A, documentation improvement only.

  • Major or minor version changes have updated the supported-versions.adoc table. N/A.

  • Build passes without console errors, warnings, or issues.


Review:

  • Documentation Team Lead has reviewed.

@kemister85 kemister85 requested review from a team and soritaheng as code owners May 14, 2026 04:05
@kemister85 kemister85 requested a review from metricjs May 14, 2026 04:52
=== Step 4: Forward proxy configuration

Ensure that the following URLs are accessible via this proxy if the network has a forward proxy that controls access to the internet.
If the network has a forward proxy that controls access to the internet, ensure that the following URLs are accessible:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

forward proxy or firewall?? I'm not an expert though to be sure

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good call — updated the section title to "Forward proxy and firewall configuration" and the body to mention both. See dea7fb0.

Comment thread modules/ROOT/pages/tinymce-and-csp.adoc Outdated
[[firewall-and-proxy-allowlisting]]
== Firewall and proxy allowlisting

Organizations operating behind a firewall or forward proxy that restricts outbound internet access must allowlist {cloudname} domains for cloud-hosted {productname} features to function.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

just outbound or outbound and inbound?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Outbound only. The browser makes standard outbound HTTPS requests to *.tiny.cloud and responses return on the same connection. No inbound allowlisting is needed. Updated the text to make this explicit: "Cloud-hosted TinyMCE features require the browser to make outbound HTTPS requests to these domains; no inbound access from Tiny Cloud is required." See dea7fb0.

* Link checking (`+hyperlinking.tiny.cloud+`)
* Spell checking (`+spelling.tiny.cloud+`)

NOTE: Self-hosted deployments that do not connect to any {cloudname} services do not require this allowlisting. For self-hosted services such as on-premises document converters or AI, allowlist the domain where the self-hosted service is running instead.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

See DM

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Checked the license key docs — self-hosted deployments validate the license key locally with no server contact (reference). Billing applies to cloud/hybrid setups. The NOTE already covers this: "Self-hosted deployments that do not connect to any Tiny Cloud services do not require this allowlisting." Hybrid setups (self-hosted editor + cloud AI/doc converters) still need *.tiny.cloud for those services, which is covered by the rest of the page.

@kemister85 kemister85 requested a review from metricjs May 14, 2026 05:10
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.

2 participants