-
Notifications
You must be signed in to change notification settings - Fork 220
DOC-3143: Update key information about trial period behaviour for document converters on Tiny Cloud. #3640
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
DOC-3143: Update key information about trial period behaviour for document converters on Tiny Cloud. #3640
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c46382c
DOC-3143: update key information about trial period behaviour for doc…
kemister85 489a5fb
Update modules/ROOT/pages/exportpdf.adoc
kemister85 a2401a8
Update modules/ROOT/pages/exportword.adoc
kemister85 2615a43
Update modules/ROOT/pages/importword.adoc
kemister85 1e35fcc
DOC-3143: add partial file for expected data structure for auth token.
kemister85 19123f2
Update modules/ROOT/pages/exportpdf.adoc
tiny-ben-tran 137d392
Update modules/ROOT/pages/exportword.adoc
tiny-ben-tran 86d8a63
Update modules/ROOT/pages/importword.adoc
tiny-ben-tran 77094bd
Update JWT authentication documentation across export and import plug…
kemister85 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
...s/ROOT/partials/misc/admon-document-converters-jwt-expected-data-structure.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| [[data-structure]] | ||
| === Data structure for the JWT token | ||
|
|
||
| The object containing the valid encoded token must match the following structure: | ||
|
|
||
| [source,js] | ||
| ---- | ||
| { | ||
| token: "<encoded JWT string>" | ||
| } | ||
| ---- | ||
|
|
||
| [cols="1,1,1,3",options="header"] | ||
| |=== | ||
| |Field |Type |Required? |Description | ||
| |`+token+` |`+string+` |required |A Base64-encoded JSON Web Token (JWT) used for authentication and authorization. | ||
| |=== |
18 changes: 18 additions & 0 deletions
18
modules/ROOT/partials/misc/admon-jwt-authentication-requirements.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| [IMPORTANT] | ||
| ==== | ||
| 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. | ||
|
|
||
| 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)] | ||
| * xref:{pluginfilename}-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_. | ||
| ==== |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.