Skip to content

Commit f508cb1

Browse files
kemister85kemister85
committed
DOC-3505: Add self-hosted trial with cloud services page
New documentation page for self-hosted trial customers explaining setup, available cloud-powered features, network requirements, limitations, and FAQ. Adds nav entry and hub page link.
1 parent eb2f2f3 commit f508cb1

3 files changed

Lines changed: 195 additions & 0 deletions

File tree

‎modules/ROOT/nav.adoc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
***** xref:bootstrap-cloud.adoc[Bootstrap]
2020
*** xref:installation-self-hosted.adoc[Self-hosted]
2121
**** xref:npm-projects.adoc[Quick start guide]
22+
**** xref:self-hosted-trial.adoc[Self-hosted trial]
2223
**** Supported Integrations
2324
***** React
2425
****** xref:react-pm-host.adoc[Using a package manager with hosting]

‎modules/ROOT/pages/installation-self-hosted.adoc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,12 @@
1313
xref:npm-projects.adoc[Quick start: NPM/Yarn]
1414

1515
Install and configure {productname} using NPM or Yarn.
16+
1617
|
18+
[.lead]
19+
xref:self-hosted-trial.adoc[Self-hosted trial]
20+
21+
Evaluate {productname} premium features and cloud services in a self-hosted environment using a trial license key.
1722
|===
1823

1924
== Integrations

‎modules/ROOT/pages/self-hosted-trial.adoc‎

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
= Self-hosted trial with cloud services
2+
:navtitle: Self-hosted trial
3+
:description: Set up a self-hosted {productname} trial with access to cloud-powered premium features using NPM.
4+
:keywords: trial, self-hosted, npm, cloud services, premium plugins, license key, tinymce-premium
5+
6+
// TODO: Update option name `cloud_services_trial` when final name is confirmed (TINY-14259).
7+
8+
== Overview
9+
10+
A self-hosted trial provides access to {productname} premium plugins and cloud-powered services in a self-hosted environment. This allows evaluation of the full {productname} feature set, including features that depend on cloud services, without requiring a separate cloud deployment or additional scripts.
11+
12+
During the trial period, {productname} connects to {cloudname} services using the trial license key. No separate API key is required.
13+
14+
[NOTE]
15+
====
16+
Only new customers can start a self-hosted trial. The trial period lasts 14 days from the date of sign-up.
17+
====
18+
19+
== Prerequisites
20+
21+
* A {productname} trial account with "self-hosted" selected as the deployment option. Sign up at link:https://www.tiny.cloud/get-tiny/[Get {productname}].
22+
* A trial license key, issued after sign-up.
23+
* https://nodejs.org/[Node.js (and npm)] installed.
24+
* A project directory with a `+package.json+` file. Initialize one by running `+npm init+` if needed.
25+
26+
== Setup
27+
28+
=== Step 1: Install {productname} and premium plugins
29+
30+
Install both the core editor and premium plugins package:
31+
32+
[source,sh,subs="attributes+"]
33+
----
34+
npm install tinymce@^{productmajorversion} tinymce-premium@^{productmajorversion}
35+
----
36+
37+
[NOTE]
38+
====
39+
The self-hosted trial also supports installation using a ZIP package. For ZIP-based setup instructions, see xref:zip-install.adoc[Quick start: ZIP]. The remaining steps in this guide apply regardless of the installation method.
40+
====
41+
42+
=== Step 2: Configure the editor with the trial license key
43+
44+
Add the trial license key to the {productname} configuration using the `+license_key+` option:
45+
46+
[source,js]
47+
----
48+
tinymce.init({
49+
selector: 'textarea', // change this value according to the HTML
50+
license_key: 'your-trial-license-key',
51+
plugins: [
52+
'advlist', 'autolink', 'lists', 'link', 'image', 'charmap', 'preview',
53+
'anchor', 'searchreplace', 'visualblocks', 'code', 'fullscreen',
54+
'insertdatetime', 'media', 'table', 'help', 'wordcount',
55+
'tinymcespellchecker', 'exportpdf', 'exportword', 'importword',
56+
'linkchecker', 'mediaembed', 'editimage', 'autocorrect', 'tinymceai'
57+
],
58+
toolbar: 'undo redo | blocks | bold italic | alignleft aligncenter alignright | bullist numlist outdent indent | help',
59+
cloud_services_trial: true
60+
});
61+
----
62+
63+
Replace the `+'your-trial-license-key'+` placeholder with the trial license key provided during sign-up.
64+
65+
=== Step 3: Enable cloud services
66+
67+
Set the `+cloud_services_trial+` option to `+true+` in the editor configuration. This option explicitly enables the connection to {cloudname} services for the duration of the trial.
68+
69+
[IMPORTANT]
70+
====
71+
Setting `+cloud_services_trial+` to `+true+` enables a network connection from the editor to {cloudname}. Features that depend on cloud services will not function without this option enabled. Remove or set this option to `+false+` to disable the cloud connection at any time.
72+
====
73+
74+
=== Step 4: Ensure the license key manager is available
75+
76+
The `+tinymce-premium+` NPM package includes the license key manager. If bundling {productname}, ensure the license key manager is imported:
77+
78+
[source,javascript]
79+
----
80+
import 'tinymce-premium/plugins/licensekeymanager';
81+
----
82+
83+
For hosting setups, ensure the `+licensekeymanager+` folder is present in the `+plugins+` directory alongside all other plugins. For more details, see xref:license-key.adoc#_setting_up_the_commercial_license_key_manager[Setting up the Commercial License Key Manager].
84+
85+
== Available features
86+
87+
The self-hosted trial includes access to the following cloud-powered premium features:
88+
89+
[cols="1,2", options="header"]
90+
|===
91+
| Feature | Description
92+
93+
| xref:introduction-to-tiny-spellchecker.adoc[Spell Checker Pro]
94+
| Real-time spellchecking powered by cloud-based language services.
95+
96+
| xref:linkchecker.adoc[Link Checker]
97+
| Validates hyperlinks within content using a cloud-based link validation service.
98+
99+
| xref:introduction-to-mediaembed.adoc[Enhanced Media Embed]
100+
| Rich media previews for URLs using a cloud-based media resolution service.
101+
102+
| xref:exportpdf.adoc[Export to PDF]
103+
| Converts editor content to PDF format using a cloud-based conversion service.
104+
105+
| xref:exportword.adoc[Export to Word]
106+
| Converts editor content to DOCX format using a cloud-based conversion service.
107+
108+
| xref:importword.adoc[Import from Word]
109+
| Imports DOCX content into the editor using a cloud-based conversion service.
110+
111+
| xref:editimage.adoc[Image Editing]
112+
| Advanced image editing with cloud-based image proxy support.
113+
114+
| xref:autocorrect.adoc[Autocorrect]
115+
| Automatic text corrections powered by cloud-based language services.
116+
117+
| xref:tinymceai.adoc[TinyMCE AI]
118+
| AI-powered content generation and editing.
119+
|===
120+
121+
In addition to cloud-powered features, all self-hosted premium plugins included in the `+tinymce-premium+` package are available during the trial without requiring a cloud connection.
122+
123+
== Network requirements
124+
125+
When `+cloud_services_trial+` is enabled, the editor connects to {cloudname} services. Ensure the following domains allow outbound access if the network uses a forward proxy or firewall:
126+
127+
* `+https://spelling.tiny.cloud+`
128+
* `+https://hyperlinking.tiny.cloud+`
129+
* `+https://imageproxy.tiny.cloud+`
130+
* `+https://exportpdf.tiny.cloud+`
131+
* `+https://exportdocx.tiny.cloud+`
132+
* `+https://importdocx.tiny.cloud+`
133+
134+
[NOTE]
135+
====
136+
The exact list of required domains depends on which cloud-powered features are enabled in the editor configuration. Only domains for enabled features require network access.
137+
====
138+
139+
== Trial limitations
140+
141+
[cols="1,2", options="header"]
142+
|===
143+
| Limitation | Details
144+
145+
| Duration
146+
| 14 days from sign-up.
147+
148+
| Eligibility
149+
| New customers only. Existing customers with an active subscription are not eligible for a self-hosted trial.
150+
151+
| After expiry
152+
| The editor ceases to function when the trial license key expires. Purchase a commercial license to continue using {productname}.
153+
154+
| Cloud services
155+
| Cloud-powered features require an active internet connection and the `+cloud_services_trial+` option set to `+true+`.
156+
|===
157+
158+
== After the trial
159+
160+
To continue using {productname} after the trial period:
161+
162+
* *Purchase a commercial license:* Visit link:https://www.tiny.cloud/pricing[{productname} Pricing] to select a plan. A commercial license key is provided for ongoing self-hosted use.
163+
* *Self-hosted premium services:* For production use of features such as Spell Checker, Export to PDF, and Import from Word, self-host the required server-side services or use a {cloudname} plan. See xref:bundle-intro-setup.adoc[Premium server-side services] for self-hosting options.
164+
* *Cloud deployment:* Alternatively, switch to a fully cloud-hosted deployment. See xref:editor-and-features.adoc[Cloud deployment] for setup instructions.
165+
166+
== FAQ
167+
168+
[cols="1,2", options="header"]
169+
|===
170+
| Question | Answer
171+
172+
| Does the trial require an API key?
173+
| No. The trial license key is the only key required. There is no need to configure a separate API key for cloud services during the trial.
174+
175+
| Can the cloud connection be disabled?
176+
| Yes. Remove the `+cloud_services_trial+` option or set it to `+false+`. Cloud-powered features will not function without this option, but all self-hosted plugins will continue to operate.
177+
178+
| What happens when the trial expires?
179+
| {productname} disables the editor and displays a notification indicating that the license key has expired. Purchase a commercial license to continue use.
180+
181+
| Is a separate script tag required for cloud services?
182+
| No. Unlike a hybrid deployment, the self-hosted trial does not require an additional script tag. The `+cloud_services_trial+` option and the trial license key handle all cloud service connectivity.
183+
184+
| Which plugins work without cloud services?
185+
| All premium plugins that do not depend on an external service function during the trial regardless of the `+cloud_services_trial+` option value. This includes plugins such as xref:advtable.adoc[Advanced Tables], xref:introduction-to-powerpaste.adoc[PowerPaste], xref:footnotes.adoc[Footnotes], and xref:mergetags.adoc[Merge Tags], among others.
186+
187+
| Can the trial be extended?
188+
| Trial extensions are not available through self-service. Contact link:https://support.tiny.cloud[{productname} Support] for assistance.
189+
|===

0 commit comments

Comments
 (0)