Skip to content

Commit a65702a

Browse files
committed
DOC-3243: Add on-premises Docker v2 API upgrade notes
- exportpdf_service_url: IMPORTANT note about v2-compatible Docker image - export-to-pdf-overview: IMPORTANT note with changelog link - exportpdf_converter_options_combined: Expand NOTE for on-premises
1 parent 6b230d8 commit a65702a

3 files changed

Lines changed: 13 additions & 1 deletion

File tree

modules/ROOT/partials/configuration/exportpdf_converter_options_combined.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Configures page layout, headers, footers, and other PDF output options. The edit
1616
Both formats use the same API endpoint. Flat-format options are converted to the nested structure automatically before the request.
1717

1818
[NOTE]
19-
Requires {productname} 8.4.0 or newer.
19+
====
20+
Requires {productname} 8.4.0 or newer. On-premises deployments require a Docker image version that supports the v2 API.
21+
====
2022

2123
=== Flat format
2224

modules/ROOT/partials/configuration/exportpdf_service_url.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ The {pluginname} plugin uses an HTML-to-PDF converter service to generate `docum
55

66
This option is **required** when configuring the {pluginname} plugin for `on-premise` setups. If you require access to this feature, please link:https://www.tiny.cloud/contact/[contact us]. For detailed instructions on deploying the {pluginname} service server-side component using Docker, refer to the xref:individual-export-to-pdf-on-premises.adoc[on-premises documentation].
77

8+
[IMPORTANT]
9+
====
10+
On-premises deployments require a Docker image version that supports the v2 API (`/v2/convert/html-pdf`). Upgrade to the latest image or a v2-compatible version to use {productname} 8.4.0 or newer with the Export to PDF plugin.
11+
====
12+
813
[TIP]
914
When using a custom host, set the `exportpdf_service_url` option in your {productname} configuration to match your host. For example, if your custom host is `mycustomhost.com`, set the URL to `https://mycustomhost.com/`.
1015

modules/ROOT/partials/individually-licensed-components/export-to-pdf/export-to-pdf-overview.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33

44
The On-Premises version of the {pluginname} Converter is an application that can be installed and run on the customer’s in-house servers and computing infrastructure, including a private cloud. It contains all the features of the {pluginname} Converter available as SaaS.
55

6+
[IMPORTANT]
7+
====
8+
To use {productname} 8.4.0 or newer with the Export to PDF plugin, the on-premises Docker image must support the v2 API (`/v2/convert/html-pdf`). Use the latest image or a v2-compatible version. See the link:https://registry.containers.tiny.cloud/api/changelogs/pdf-converter-tiny[changelog^] for version details.
9+
====
10+
611
A valid license key is required in order to install {pluginname} Converter On-Premises. You will also need an access token to access the {companyname} Cloud Docker registry and pull the Docker image.
712

813
To get started, link:https://www.tiny.cloud/contact/[Contact Tiny Support] for a trial license key and Docker access token.

0 commit comments

Comments
 (0)