Skip to content

Commit 3fea266

Browse files
committed
DOC-3506: Add firewall whitelist instructions to AI and Doc Converters docs
1 parent eb2f2f3 commit 3fea266

7 files changed

Lines changed: 54 additions & 13 deletions

File tree

modules/ROOT/pages/editor-and-features.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,15 @@ include::partial$misc/admon-cloud-configured-options.adoc[]
5656

5757
=== Step 4: Forward proxy configuration
5858

59-
Ensure that the following URLs are accessible via this proxy if the network has a forward proxy that controls access to the internet.
59+
If the network has a forward proxy that controls access to the internet, ensure that the following URLs are accessible:
6060

6161
* All URLs where the editor is deployed.
6262
* All URLs where the plugins are deployed.
63-
* +https://imageproxy.tiny.cloud+
64-
* +https://hyperlinking.tiny.cloud+
65-
* +https://spelling.tiny.cloud+
63+
* `+*.tiny.cloud+` — covers all {cloudname} services, including the image proxy, link checker, spell checker, AI, and document converters.
6664

67-
Ensure the `+tiny-api-key+` and `+tinymce-api-key+` headers are retained while requesting the list of above URLs.
65+
Ensure the `+tiny-api-key+` and `+tinymce-api-key+` headers are retained while requesting the above URLs.
66+
67+
For the full list of {cloudname} service domains and required headers, see xref:tinymce-and-csp.adoc#firewall-and-proxy-allowlisting[Firewall and proxy allowlisting].
6868

6969
=== Step 5: Specifying a translation
7070

modules/ROOT/pages/exportword.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111

1212
include::partial$misc/admon-export-word-paid-addon-pricing.adoc[]
1313

14+
include::partial$misc/admon-cloud-firewall.adoc[]
15+
1416
The export to Microsoft Word feature collects the HTML generated with the `tinymce.editor.getContent()` method and combines it with the default editor content styles along with the styles provided in the plugin configuration. The combined content and styles are then processed by the included server-side converter service, which can be either self-hosted or cloud-based. Following this processing, a Word file is generated, which is subsequently returned to the user's browser, enabling them to save it in the Word format onto their disk or drive.
1517

1618
== Interactive example

modules/ROOT/pages/features-only.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,12 +57,12 @@ The following is a complete example, where:
5757

5858
== Step 3: Forward proxy configuration
5959

60-
Ensure that the following URLs are accessible via this proxy if the network has a forward proxy that controls access to the internet.
60+
If the network has a forward proxy that controls access to the internet, ensure that the following URLs are accessible:
6161

6262
* All URLs where the editor is deployed.
6363
* All URLs where the plugins are deployed.
64-
* +https://imageproxy.tiny.cloud+
65-
* +https://hyperlinking.tiny.cloud+
66-
* +https://spelling.tiny.cloud+
64+
* `+*.tiny.cloud+` — covers all {cloudname} services, including the image proxy, link checker, spell checker, AI, and document converters.
6765

68-
Ensure the `+tiny-api-key+` and `+tinymce-api-key+` headers are retained while requesting the list of above URLs.
66+
Ensure the `+tiny-api-key+` and `+tinymce-api-key+` headers are retained while requesting the above URLs.
67+
68+
For the full list of {cloudname} service domains and required headers, see xref:tinymce-and-csp.adoc#firewall-and-proxy-allowlisting[Firewall and proxy allowlisting].

modules/ROOT/pages/importword.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ include::partial$misc/admon-import-word-paid-addon-pricing.adoc[]
1313

1414
The {pluginname} plugin lets you import `.docx` (Word document) or `.dotx` (Word template) files into the editor. The process preserves formatting and rich media.
1515

16+
include::partial$misc/admon-cloud-firewall.adoc[]
17+
1618
== Interactive example
1719

1820
liveDemo::importword[]
Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,44 @@
1-
= The TinyMCE Content Security Policy guide
1+
= {productname} Content Security Policy and allowed domains
22
:navtitle: Content Security Policies (CSP)
3-
:description: Information and options related to using TinyMCE with a Content Security Policy (CSP)
4-
:keywords: security, csp
3+
:description: Content Security Policy directives, firewall allowlisting, and proxy configuration for {productname} and {cloudname} services
4+
:keywords: security, csp, firewall, allowlist, proxy, whitelist
55

66
include::partial$misc/general-csp.adoc[]
77

8+
[[firewall-and-proxy-allowlisting]]
9+
== Firewall and proxy allowlisting
10+
11+
Organizations operating behind a firewall or forward proxy that restricts outbound internet access must allowlist {cloudname} domains for cloud-hosted {productname} features to function.
12+
13+
[[required-domains]]
14+
=== Required domains
15+
16+
Allowlist the following wildcard domain to cover all {cloudname} services:
17+
18+
`+*.tiny.cloud+`
19+
20+
This single entry covers all cloud-hosted services, including but not limited to:
21+
22+
* Editor loading and plugin delivery (`+cdn.tiny.cloud+`)
23+
* xref:tinymceai.adoc[TinyMCE AI] (`+tinymceai.api.tiny.cloud+`)
24+
* xref:importword.adoc[Import from Word] (`+importdocx.api.tiny.cloud+`)
25+
* xref:exportword.adoc[Export to Word] (`+exportdocx.api.tiny.cloud+`)
26+
* Image proxy (`+imageproxy.tiny.cloud+`)
27+
* Link checking (`+hyperlinking.tiny.cloud+`)
28+
* Spell checking (`+spelling.tiny.cloud+`)
29+
30+
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.
31+
32+
[[required-http-headers]]
33+
=== Required HTTP headers
34+
35+
Ensure the proxy retains (does not strip) the following HTTP headers on requests to `+*.tiny.cloud+` domains:
36+
37+
* `+tiny-api-key+`
38+
* `+tinymce-api-key+`
39+
40+
These headers are required for API key validation and service authentication.
41+
842
== Content Security Policy related options
943

1044
include::partial$configuration/content_security_policy.adoc[leveloffset=+1]

modules/ROOT/pages/tinymceai.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ include::partial$misc/admon-premium-plugin.adoc[]
1313

1414
The {pluginname} plugin integrates AI-assisted authoring with rich-text editing. Users can interact through Actions, Reviews, or Conversations that can use relevant context from multiple sources.
1515

16+
include::partial$misc/admon-cloud-firewall.adoc[]
17+
1618
[[interactive-example]]
1719
== Interactive example
1820

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
NOTE: When using the cloud-hosted service behind a firewall or forward proxy, ensure `+*.tiny.cloud+` is allowlisted and that required HTTP headers are not stripped. See xref:tinymce-and-csp.adoc#firewall-and-proxy-allowlisting[Firewall and proxy allowlisting] for details.

0 commit comments

Comments
 (0)