Skip to content

Commit b27d293

Browse files
committed
DOC-3143: update key information about trial period behaviour for document converters on Tiny Cloud.
1 parent 1b8c3de commit b27d293

File tree

6 files changed

+85
-30
lines changed

6 files changed

+85
-30
lines changed

modules/ROOT/pages/exportpdf.adoc

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,37 @@ tinymce.init({
3030
selector: 'textarea',
3131
plugins: 'exportpdf',
3232
toolbar: 'exportpdf',
33+
exportpdf_token_provider: () => { // required when using the Export to PDF plugin with Tiny Cloud.
34+
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
35+
method: 'POST',
36+
headers: { 'Content-Type': 'application/json' },
37+
}).then(response => response.json());
38+
},
3339
});
3440
----
3541

42+
[NOTE]
43+
For more infomation on the exportpdf_token_provider option, see xref:exportpdf.adoc#exportpdf-token-provider[exportpdf_token_provider].
44+
3645
[IMPORTANT]
37-
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:
46+
====
47+
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
48+
49+
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
50+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
51+
52+
For more information on how to set up JWT authentication with {pluginname}, see examples:
3853
39-
* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
40-
* xref:export-to-pdf-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
54+
* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Export to PDF with JWT authentication (Node.js)]
55+
* xref:export-to-pdf-with-jwt-authentication-php.adoc[Export to PDF with JWT authentication (PHP)]
56+
57+
**Trial period behavior:**
58+
59+
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
60+
* The `{plugincode}_token_provider` option is "not required" during the trial period.
61+
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
62+
* Attempting to use JWT authentication during the trial will result in an _error_.
63+
====
4164

4265
== Basic setup using the self-hosted service
4366

modules/ROOT/pages/exportword.adoc

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,43 @@ tinymce.init({
3636
selector: 'textarea',
3737
plugins: 'exportword',
3838
toolbar: 'exportword',
39+
exportword_token_provider: () => { // required when using the Export to Word plugin with Tiny Cloud.
40+
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
41+
method: 'POST',
42+
headers: { 'Content-Type': 'application/json' },
43+
}).then(response => response.json());
44+
},
3945
});
4046
----
4147

48+
[NOTE]
49+
For more infomation on the exportword_token_provider option, see xref:exportword.adoc#exportword-token-provider[exportword_token_provider]
50+
4251
[IMPORTANT]
43-
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:
52+
====
53+
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
54+
55+
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
56+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
57+
58+
For more information on how to set up JWT authentication with {pluginname}, see examples:
4459
4560
* xref:export-to-word-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
4661
* xref:export-to-word-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
4762
63+
**Trial period behavior:**
64+
65+
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
66+
* The `{plugincode}_token_provider` option is "not required" during the trial period.
67+
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
68+
* Attempting to use JWT authentication during the trial will result in an _error_.
69+
====
70+
71+
72+
73+
74+
75+
4876
== Basic setup using the self-hosted service
4977

5078
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.

modules/ROOT/pages/importword.adoc

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,15 +31,38 @@ tinymce.init({
3131
selector: 'textarea',
3232
plugins: 'importword',
3333
toolbar: 'importword',
34+
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
35+
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
36+
method: 'POST',
37+
headers: { 'Content-Type': 'application/json' },
38+
}).then(response => response.json());
39+
},
3440
});
3541
----
3642

43+
[NOTE]
44+
For more infomation on the importword_token_provider option, see xref:importword.adoc#importword-token-provider[importword_token_provider].
45+
3746
[IMPORTANT]
38-
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:
47+
====
48+
The {pluginname} plugin **requires** JWT authentication when using the {companyname} Cloud service.
49+
50+
* Configure the `{plugincode}_token_provider` option to specify the endpoint for retrieving a valid JWT token.
51+
* If hosting locally, use the format `+http://localhost:[port]/jwt+`, ensuring the endpoint returns a JSON object containing the token.
52+
53+
For more information on how to set up JWT authentication with {pluginname}, see examples:
3954
4055
* xref:import-from-word-with-jwt-authentication-nodejs.adoc[{pluginname} with JWT authentication (Node.js)]
4156
* xref:import-from-word-with-jwt-authentication-php.adoc[{pluginname} with JWT authentication (PHP)]
4257
58+
**Trial period behavior:**
59+
60+
* The {pluginname} plugin runs in evaluation mode and adds a watermark to exported content.
61+
* The `{plugincode}_token_provider` option is "not required" during the trial period.
62+
* If the trial period "expires" or the plugin lacks the necessary entitlement, it becomes _non-functional_.
63+
* Attempting to use JWT authentication during the trial will result in an _error_.
64+
====
65+
4366
== Basic setup using the self-hosted service
4467

4568
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.

modules/ROOT/partials/configuration/exportpdf_token_provider.adoc

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,11 @@ tinymce.init({
1515
selector: 'textarea',
1616
plugins: 'exportpdf',
1717
toolbar: 'exportpdf',
18-
exportpdf_token_provider: () => {
18+
exportpdf_token_provider: () => { // required when using the Export to PDF plugin with Tiny Cloud.
1919
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
2020
method: 'POST',
2121
headers: { 'Content-Type': 'application/json' },
2222
}).then(response => response.json());
2323
},
2424
});
25-
----
26-
27-
[NOTE]
28-
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:
29-
30-
* xref:export-to-pdf-with-jwt-authentication-nodejs.adoc[Export to PDF with JWT authentication (Node.js)]
31-
* xref:export-to-pdf-with-jwt-authentication-php.adoc[Export to PDF with JWT authentication (PHP)]
25+
----

modules/ROOT/partials/configuration/exportword_token_provider.adoc

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,11 @@ tinymce.init({
1515
selector: 'textarea',
1616
plugins: 'exportword',
1717
toolbar: 'exportword',
18-
exportword_token_provider: () => {
18+
exportword_token_provider: () => { // required when using the Export to Word plugin with Tiny Cloud.
1919
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
2020
method: 'POST',
2121
headers: { 'Content-Type': 'application/json' },
2222
}).then(response => response.json());
2323
},
2424
});
25-
----
26-
27-
28-
[NOTE]
29-
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:
30-
31-
* xref:export-to-word-with-jwt-authentication-nodejs.adoc[Export to Word with JWT authentication (Node.js)]
32-
* xref:export-to-word-with-jwt-authentication-php.adoc[Export to Word with JWT authentication (PHP)]
25+
----

modules/ROOT/partials/configuration/importword_token_provider.adoc

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,17 +15,11 @@ tinymce.init({
1515
selector: 'textarea',
1616
plugins: 'importword',
1717
toolbar: 'importword',
18-
importword_token_provider: () => {
18+
importword_token_provider: () => { // required when using the Import from Word plugin with Tiny Cloud.
1919
return fetch('http://localhost:3000/jwt', { // specify your token endpoint
2020
method: 'POST',
2121
headers: { 'Content-Type': 'application/json' },
2222
}).then(response => response.json());
2323
},
2424
});
25-
----
26-
27-
[NOTE]
28-
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:
29-
30-
* xref:import-from-word-with-jwt-authentication-nodejs.adoc[Import to Word with JWT authentication (Node.js)]
31-
* xref:import-from-word-with-jwt-authentication-php.adoc[Import to Word with JWT authentication (PHP)]
25+
----

0 commit comments

Comments
 (0)