diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index f9327d1f6f..b3ee18aacd 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -19,6 +19,7 @@ ***** xref:bootstrap-cloud.adoc[Bootstrap] *** xref:installation-self-hosted.adoc[Self-hosted] **** xref:npm-projects.adoc[Quick start guide] +**** xref:self-hosted-trial.adoc[Self-hosted trial] **** Supported Integrations ***** React ****** xref:react-pm-host.adoc[Using a package manager with hosting] diff --git a/modules/ROOT/pages/installation-self-hosted.adoc b/modules/ROOT/pages/installation-self-hosted.adoc index b4254b7777..a7f32ae1f6 100644 --- a/modules/ROOT/pages/installation-self-hosted.adoc +++ b/modules/ROOT/pages/installation-self-hosted.adoc @@ -13,7 +13,12 @@ xref:npm-projects.adoc[Quick start: NPM/Yarn] Install and configure {productname} using NPM or Yarn. + | +[.lead] +xref:self-hosted-trial.adoc[Self-hosted trial] + +Evaluate {productname} premium features and cloud services in a self-hosted environment using a trial license key. |=== == Integrations diff --git a/modules/ROOT/pages/self-hosted-trial.adoc b/modules/ROOT/pages/self-hosted-trial.adoc new file mode 100644 index 0000000000..7d0cb802dd --- /dev/null +++ b/modules/ROOT/pages/self-hosted-trial.adoc @@ -0,0 +1,176 @@ += Self-hosted trial with cloud services +:navtitle: Self-hosted trial +:description: Set up a self-hosted {productname} trial with access to cloud-powered premium features using NPM. +:keywords: trial, self-hosted, npm, cloud services, premium plugins, license key, tinymce-premium + +// TODO: Update option name `cloud_services_trial` when final name is confirmed (TINY-14259). + +== Overview + +A self-hosted trial provides access to {productname} premium plugins in a self-hosted environment. Integrators can optionally connect to {cloudname} services during the trial to evaluate cloud-powered features such as Spell Checker Pro, Export to PDF, and TinyMCE AI, without requiring a separate cloud deployment or additional scripts. + +Connecting to cloud services is opt-in. Setting the `+cloud_services_trial+` option to `+true+` enables the connection. Without this option, the editor operates entirely offline with no cloud dependency. No separate API key is required. + +[NOTE] +==== +Only new customers can start a self-hosted trial. For trial duration and entitlement details, see the link:https://www.tiny.cloud/my-account[Tiny Cloud Account] portal. +==== + +== Prerequisites + +* A {productname} trial account with "self-hosted" selected as the deployment option. Sign up at link:https://www.tiny.cloud/get-tiny/[Get {productname}]. +* A trial license key, issued after sign-up. +* https://nodejs.org/[Node.js (and npm)] installed. +* A project directory with a `+package.json+` file. Initialize one by running `+npm init+` if needed. + +== Setup + +=== Step 1: Install {productname} and premium plugins + +Install both the core editor and premium plugins package: + +[source,sh,subs="attributes+"] +---- +npm install tinymce@^{productmajorversion} tinymce-premium@^{productmajorversion} +---- + +=== Step 2: Configure the editor with the trial license key + +Add the trial license key to the {productname} configuration using the `+license_key+` option: + +[source,js] +---- +tinymce.init({ + selector: 'textarea', // change this value according to the HTML + license_key: 'your-trial-license-key', + plugins: [ + 'advlist', 'autolink', 'lists', 'link', 'image', 'charmap', 'preview', + 'anchor', 'searchreplace', 'visualblocks', 'code', 'fullscreen', + 'insertdatetime', 'media', 'table', 'help', 'wordcount', + 'tinymcespellchecker', 'exportpdf', 'exportword', 'importword', + 'linkchecker', 'mediaembed', 'editimage', 'autocorrect', 'tinymceai' + ], + toolbar: 'undo redo | blocks | bold italic | alignleft aligncenter alignright | bullist numlist outdent indent | help', + cloud_services_trial: true +}); +---- + +Replace the `+'your-trial-license-key'+` placeholder with the trial license key provided during sign-up. + +=== Step 3: Enable cloud services + +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. + +[IMPORTANT] +==== +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. +==== + +=== Step 4: Ensure the license key manager is available + +The `+tinymce-premium+` NPM package includes the license key manager. If bundling {productname}, ensure the license key manager is imported: + +[source,javascript] +---- +import 'tinymce-premium/plugins/licensekeymanager'; +---- + +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]. + +== Cloud-powered features + +The following premium features require a connection to {cloudname} services and will only function when `+cloud_services_trial+` is set to `+true+`: + +[cols="1,2", options="header"] +|=== +| Feature | Description + +| xref:introduction-to-tiny-spellchecker.adoc[Spell Checker Pro] +| Real-time spellchecking powered by cloud-based language services. + +| xref:linkchecker.adoc[Link Checker] +| Validates hyperlinks within content using a cloud-based link validation service. + +| xref:introduction-to-mediaembed.adoc[Enhanced Media Embed] +| Rich media previews for URLs using a cloud-based media resolution service. + +| xref:exportpdf.adoc[Export to PDF] +| Converts editor content to PDF format using a cloud-based conversion service. + +| xref:exportword.adoc[Export to Word] +| Converts editor content to DOCX format using a cloud-based conversion service. + +| xref:importword.adoc[Import from Word] +| Imports DOCX content into the editor using a cloud-based conversion service. + +| xref:editimage.adoc[Image Editing] +| Advanced image editing with cloud-based image proxy support. + +| xref:autocorrect.adoc[Autocorrect] +| Automatic text corrections powered by cloud-based language services. + +| xref:tinymceai.adoc[TinyMCE AI] +| AI-powered content generation and editing. +|=== + +All other premium plugins included in the `+tinymce-premium+` package function during the trial without a cloud connection. + +For the full list of features included in a trial, see the link:https://www.tiny.cloud/my-account[Tiny Cloud Account] portal. + +== Network requirements + +When `+cloud_services_trial+` is enabled, the editor connects to {cloudname} services. Ensure that `+*.tiny.cloud+` is allowed for outbound access if the network uses a forward proxy or firewall. + +For detailed Content Security Policy (CSP) configuration, see xref:tinymce-and-csp.adoc[{productname} and Content Security Policy]. + +== Trial limitations + +[cols="1,2", options="header"] +|=== +| Limitation | Details + +| Duration +| The trial period begins at sign-up. For the current trial duration, see the link:https://www.tiny.cloud/my-account[Tiny Cloud Account] portal. + +| Eligibility +| New customers only. Existing customers with an active subscription are not eligible for a self-hosted trial. + +| After expiry +| The editor ceases to function when the trial license key expires. Purchase a commercial license to continue using {productname}. + +| Cloud services +| Cloud-powered features require an active internet connection and the `+cloud_services_trial+` option set to `+true+`. Without this option, no cloud connection is made. +|=== + +== After the trial + +To continue using {productname} after the trial period: + +* *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. +* *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. +* *Cloud deployment:* Alternatively, switch to a fully cloud-hosted deployment. See xref:editor-and-features.adoc[Cloud deployment] for setup instructions. + +== FAQ + +[cols="1,2", options="header"] +|=== +| Question | Answer + +| Does the trial require an API key? +| 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. + +| Can the cloud connection be disabled? +| 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. + +| What happens when the trial expires? +| {productname} disables the editor and displays a notification indicating that the license key has expired. Purchase a commercial license to continue use. + +| Is a separate script tag required for cloud services? +| 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. + +| Which plugins work without cloud services? +| All premium plugins that do not depend on an external service function during the trial regardless of the `+cloud_services_trial+` option value. Only the features listed in <> require the cloud connection to be enabled. + +| Can the trial be extended? +| Trial extensions are not available through self-service. Contact link:https://support.tiny.cloud[{productname} Support] for assistance. +|===