Skip to content

Commit

Permalink
DOC-3143: update key information about trial period behaviour for doc…
Browse files Browse the repository at this point in the history
…ument converters on Tiny Cloud.
  • Loading branch information
kemister85 committed Feb 27, 2025
1 parent 1b8c3de commit b27d293
Show file tree
Hide file tree
Showing 6 changed files with 85 additions and 30 deletions.
29 changes: 26 additions & 3 deletions modules/ROOT/pages/exportpdf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,37 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportpdf',
toolbar: 'exportpdf',
exportpdf_token_provider: () => { // required when using the Export to PDF plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----

[NOTE]
For more infomation on the exportpdf_token_provider option, see xref:exportpdf.adoc#exportpdf-token-provider[exportpdf_token_provider].

[IMPORTANT]
When using the {pluginname} plugin with the {companyname} Cloud service, JWT authentication is required to use the service. For more information on how to set up JWT authentication with {pluginname}, see examples:
====
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
For more information on how to set up JWT authentication with {pluginname}, see examples:
* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
* xref:export-to-pdf-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Export to PDF with JWT authentication (Node.js)]
* xref:export-to-pdf-with-jwt-authentication-php.adoc[Export to PDF with JWT authentication (PHP)]
**Trial period behavior:**
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
* The `{plugincode}_token_provider` option is "not required" during the trial period.
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
* Attempting to use JWT authentication during the trial will result in an _error_.
====

== Basic setup using the self-hosted service

Expand Down
30 changes: 29 additions & 1 deletion modules/ROOT/pages/exportword.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,43 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportword',
toolbar: 'exportword',
exportword_token_provider: () => { // required when using the Export to Word plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----

[NOTE]
For more infomation on the exportword_token_provider option, see xref:exportword.adoc#exportword-token-provider[exportword_token_provider]

[IMPORTANT]
When using the {pluginname} plugin with the {companyname} Cloud service, JWT authentication is required to use the service. For more information on how to set up JWT authentication with {pluginname}, see examples:
====
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
For more information on how to set up JWT authentication with {pluginname}, see examples:
* xref:export-to-word-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
* xref:export-to-word-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
**Trial period behavior:**
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
* The `{plugincode}_token_provider` option is "not required" during the trial period.
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
* Attempting to use JWT authentication during the trial will result in an _error_.
====






== Basic setup using the self-hosted service

To use the self-hosted version of the {pluginname} plugin, you need to set the `exportword_service_url` option to the URL of the service.
Expand Down
25 changes: 24 additions & 1 deletion modules/ROOT/pages/importword.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,38 @@ tinymce.init({
selector: 'textarea',
plugins: 'importword',
toolbar: 'importword',
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----

[NOTE]
For more infomation on the importword_token_provider option, see xref:importword.adoc#importword-token-provider[importword_token_provider].

[IMPORTANT]
When using the {pluginname} plugin with the {companyname} Cloud service, JWT authentication is required to use the service. For more information on how to set up JWT authentication with {pluginname}, see examples:
====
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
For more information on how to set up JWT authentication with {pluginname}, see examples:
* xref:import-from-word-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
* xref:import-from-word-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
**Trial period behavior:**
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
* The `{plugincode}_token_provider` option is "not required" during the trial period.
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
* Attempting to use JWT authentication during the trial will result in an _error_.
====

== Basic setup using the self-hosted service

To use the self-hosted version of the {pluginname} plugin, you need to set the `importword_service_url` option to the URL of the service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,11 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportpdf',
toolbar: 'exportpdf',
exportpdf_token_provider: () => {
exportpdf_token_provider: () => { // required when using the Export to PDF plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----

[NOTE]
The `exportpdf_token_provider` option is required when using the {companyname} Cloud service. For more information on how to set up JWT authentication with {pluginname}, see examples:

* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Export to PDF with JWT authentication (Node.js)]
* xref:export-to-pdf-with-jwt-authentication-php.adoc[Export to PDF with JWT authentication (PHP)]
----
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,11 @@ tinymce.init({
selector: 'textarea',
plugins: 'exportword',
toolbar: 'exportword',
exportword_token_provider: () => {
exportword_token_provider: () => { // required when using the Export to Word plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----


[NOTE]
The `exportword_token_provider` option is required when using the {companyname} Cloud service. For more information on how to set up JWT authentication with {pluginname}, see examples:

* xref:export-to-word-with-jwt-authentication-nodejs.adoc[Export to Word with JWT authentication (Node.js)]
* xref:export-to-word-with-jwt-authentication-php.adoc[Export to Word with JWT authentication (PHP)]
----
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,11 @@ tinymce.init({
selector: 'textarea',
plugins: 'importword',
toolbar: 'importword',
importword_token_provider: () => {
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
method: 'POST',
headers: { 'Content-Type': 'application/json' },
}).then(response => response.json());
},
});
----

[NOTE]
The `importword_token_provider` option is required when using the {companyname} Cloud service. For more information on how to set up JWT authentication with {pluginname}, see examples:

* xref:import-from-word-with-jwt-authentication-nodejs.adoc[Import to Word with JWT authentication (Node.js)]
* xref:import-from-word-with-jwt-authentication-php.adoc[Import to Word with JWT authentication (PHP)]
----

0 comments on commit b27d293

Please sign in to comment.