Skip to content

Commit ae55c31

Browse files
committed
DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions. (#3755)
* DOC-3227: Update Document Converter JWT authentication requirements and plugin descriptions for clarity. * Update modules/ROOT/partials/misc/admon-jwt-authentication-requirements.adoc * DOC-3227: Update JWT authentication requirements for trial period clarity, add ifeval condition.
1 parent bfc3a11 commit ae55c31

File tree

4 files changed

+33
-17
lines changed

4 files changed

+33
-17
lines changed

modules/ROOT/pages/exportpdf.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ tinymce.init({
2828
selector: 'textarea',
2929
plugins: 'exportpdf',
3030
toolbar: 'exportpdf',
31-
// Below option is only required when using the cloud-based Export to PDF plugin from Tiny.Cloud.
32-
// Avoid setting it up during the trial period.
31+
// Required for the cloud-based Export to PDF plugin with Tiny Cloud
32+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
3333
exportpdf_token_provider: () => {
3434
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
3535
method: 'POST',

modules/ROOT/pages/exportword.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ tinymce.init({
3535
selector: 'textarea',
3636
plugins: 'exportword',
3737
toolbar: 'exportword',
38-
// Below option is only required when using the cloud-based Export to Word plugin from Tiny.Cloud.
39-
// Avoid setting it up during the trial period.
38+
// Required for the cloud-based Export to Word plugin with Tiny Cloud
39+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
4040
exportword_token_provider: () => {
4141
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
4242
method: 'POST',

modules/ROOT/pages/importword.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
= {pluginname} plugin
32
:plugincode: importword
43
:pluginname: Import from Word
@@ -30,9 +29,9 @@ tinymce.init({
3029
selector: 'textarea',
3130
plugins: 'importword',
3231
toolbar: 'importword',
33-
// Below option is only required when using the cloud-based Import from Word plugin from Tiny.Cloud.
34-
// Avoid setting it up during the trial period.
35-
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
32+
// Required for the cloud-based Import from Word plugin with Tiny Cloud
33+
// Create a JWT key in the Customer Portal for trial functionality to enable watermark-free exports during the trial period
34+
importword_token_provider: () => {
3635
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
3736
method: 'POST',
3837
headers: { 'Content-Type': 'application/json' },

modules/ROOT/partials/misc/admon-jwt-authentication-requirements.adoc

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,34 @@
22
====
33
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
44
5-
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
5+
**Authentication Setup:**
66
7-
For more information on how to set up JWT authentication with {pluginname}, see examples:
7+
. Create a JWT key in the Customer Portal
8+
. Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving your JWT token
89
9-
* xref:{pluginfilename}-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
10-
* xref:{pluginfilename}-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
10+
For more information on how to set up JWT authentication with {pluginname}, see examples: xref:{pluginfilename}-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)] or xref:{pluginfilename}-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
1111
12-
**Trial period behavior:**
12+
**Trial period behavior**
1313
14-
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
15-
* The `{plugincode}_token_provider` option is "not required" during the trial period.
16-
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
17-
* Attempting to use JWT authentication during the trial will result in an _error_.
14+
ifeval::["{plugincode}" == "importword"]
15+
* **Trial Period:**
16+
** With JWT: Full functionality, unlimited usage, no watermarks.
17+
** Without JWT: Full functionality with watermarks and page limits.
18+
19+
* **After Trial:**
20+
** With {pluginname} add-on + JWT: Full functionality (subscription-based)
21+
** Without add-on: Plugin entitlements are `disabled` and functionality is no longer available.
22+
endif::[]
23+
24+
ifeval::["{plugincode}" != "importword"]
25+
* **Trial Period:**
26+
** With JWT: Full functionality, unlimited usage, no watermarks.
27+
** Without JWT: Full functionality with watermarks.
28+
29+
* **After Trial:**
30+
** With {pluginname} add-on + JWT: Full functionality (subscription-based)
31+
** Without add-on: Plugin entitlements are `disabled` and functionality is no longer available.
32+
endif::[]
33+
34+
Visit the link:https://www.tiny.cloud/auth/login/[account portal] to obtain your JWT key and test full functionality.
1835
====

0 commit comments

Comments
 (0)