Skip to content

Commit 52f01db

Browse files
Merge pull request mendix#10462 from ozgeMendix/uia-1274-update-private-pdf-service
[UIA-1274] Highlight private PDF service
2 parents cd80860 + 79b4b26 commit 52f01db

1 file changed

Lines changed: 22 additions & 11 deletions

File tree

content/en/docs/marketplace/platform-supported-content/modules/document-generation.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ The [PDF Document Generation](https://marketplace.mendix.com/link/component/2115
2525
* [Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/)
2626
* [Mendix Cloud Dedicated](/developerportal/deploy/mendix-cloud-deploy/)
2727
* [Mendix on Kubernetes Connected](/developerportal/deploy/private-cloud/)
28+
* [Private PDF Document Generation Service](#run-private-service)
2829
* [On-Premises](/developerportal/deploy/on-premises-design/)
29-
* A privately hosted Docker containerized PDF Document Generation service. It is available starting with module versions 1.11.0 for Studio Pro 9 and 2.1.0 for Studio Pro 10. For more information, refer to [Private PDF Document Generation Service](/appstore/services/private-document-generation-service/).
30+
3031
{{% alert color="info" %}}We only support apps that allow bi-directional communication with the PDF Service in Mendix Cloud for all deployment types except for on-premises, and for the [Private PDF Document Generation Service](/appstore/services/private-document-generation-service/).{{% /alert %}}
3132
* The maximum file size is 25 MB per document. If your document exceeds this limit, the action will result in an exception. We recommend compressing high-resolution images to reduce their file size.
3233
* If your app is configured to [restrict access for incoming requests](/developerportal/deploy/access-restrictions/) using client certificates, our cloud service will not be able to reach your app, and the module will not work properly.
@@ -67,14 +68,16 @@ Follow the instructions in [How to Use Marketplace Content](/appstore/use-conten
6768
5. To test the module locally, perform the procedure as described in the [Running locally from Studio Pro](#run-locally) section.
6869
6. When deploying your app, consider that we currently support two types of deployments:
6970

70-
1. [Running on Mendix Cloud](#run-on-mendix-cloud) using the PDF service in the Mendix Public Platform. This option is available for apps that are deployed to the following environments:
71+
1. [Running on Mendix Cloud](#run-on-mendix-cloud) using the PDF Service in the Mendix Public Platform. This option is available for apps that are deployed to the following environments:
7172
* [Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/)
7273
* [Mendix Cloud Dedicated](/developerportal/deploy/mendix-cloud-deploy/)
7374
* [Mendix on Kubernetes Connected](/developerportal/deploy/private-cloud/)
7475

75-
2. [Running On-Premises](#run-on-premises) using a local version of the PDF service. This option is available for apps that are deployed to the following environments:
76-
* [Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/)
77-
* [Linux](/developerportal/deploy/linux/)
76+
2. [Running on self-hosted for airgapped and on-premises](#run-private-service-and-on-premises) using a self-hosted version of the PDF Service:
77+
* Using [Private PDF Document Generation Service](#run-private-service) (recommended)
78+
* Using a local version of the PDF Service, available for [Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/) and [Linux](/developerportal/deploy/linux/)
79+
80+
{{% alert color="info" %}}The PDF Service in the Mendix Public Platform is also available for any other deployment type that allows bidirectional communication with the PDF Service. In this case, [submit a support request](/support/submit-support-request/) with the details of the app environment(s) to register your app.{{% /alert %}}
7881

7982
### Running Locally from Studio Pro {#run-locally}
8083

@@ -156,39 +159,47 @@ To allow the module to send and receive document generation requests on your Men
156159

157160
If your app is configured to [restrict access for incoming requests](/developerportal/deploy/access-restrictions/) using IP restrictions, you must add the [outbound IP addresses of the DocGen service](/developerportal/deploy/mendix-ip-addresses/#global-platform-ips-outbound) to the list of allowed addresses.
158161

159-
### Running On-Premises {#run-on-premises}
162+
### Running on self-hosted for airgapped and on-premises {#run-private-service-and-on-premises}
163+
164+
#### Running Private PDF Document Generation Service {#run-private-service}
165+
166+
When access to the public Mendix PDF generation Service is restricted, particularly in isolated or airgapped environments, Mendix offers a privately hosted, Docker containerized PDF Document Generation Service as an alternative. With this deployment type, you can host the document generation service on your own infrastructure and have full control over resources, availability and scalability. In addition, this option offers configurable limits, such as the maximum file size and maximum page rendering time.
167+
168+
It is available starting with module versions 1.11.0 for Studio Pro 9, and 2.1.0 for Studio Pro 10. For more detailed information, installation guide and configuration, refer to [Private PDF Document Generation Service](/appstore/services/private-document-generation-service/).
169+
170+
#### Running a local version of the PDF Service on Windows or Linux {#run-on-premises}
160171

161172
To configure the module to generate documents on your on-premises environments, you need to perform the following steps:
162173

163174
1. Make sure that you have the prerequisite software installed.
164175
2. Configure the module to use the local service.
165176
3. Enable the DocGen request handler.
166177

167-
#### Installing the Prerequisite Software {#install-prerequisites}
178+
##### Installing the Prerequisite Software {#install-prerequisites}
168179

169180
You should pre-install and actively maintain the following software. Mendix does not provide support for the installation, configuration, and maintenance of these packages.
170181

171-
##### Chromium
182+
###### Chromium
172183

173184
You should have installed a stable release of the Chromium browser. The currently supported stable release is 112.0.5615.0 ([Windows](https://storage.googleapis.com/chromium-browser-snapshots/index.html?prefix=Win_x64/1109252/). [Linux](https://storage.googleapis.com/chromium-browser-snapshots/index.html?prefix=Linux_x64/1109252/)).
174185

175186
{{% alert color="info" %}}Even though we advise using Chromium, you can also use Google Chrome instead. The configuration remains the same.{{% /alert %}}
176187

177-
##### Node.js
188+
###### Node.js
178189

179190
You should have installed a stable release of [Node.js](https://nodejs.org/). Mendix recommends installing the same version that is shipped with the Studio Pro version that is used to build the project. You can find this version by locating and executing the `node` executable within the `modeler/tools/node` folder of your Studio Pro installation.
180191

181192
{{% alert color="info" %}}Make sure that the Mendix Runtime has the applicable permissions to run the *node* executable.{{% /alert %}}
182193

183-
#### Configuring the Module to use the Local Service {#configure-local-service}
194+
##### Configuring the Module to use the Local Service {#configure-local-service}
184195

185196
1. Set the **OverrideServiceType** constant to *Local* in the **_UseMe** > **Configuration** folder. This enforces the use of the local service instead of the cloud service.
186197

187198
2. Configure the path to the *chrome* executable in the **CustomChromePath** constant in the **_UseMe** > **Configuration** folder.
188199

189200
3. Configure the path to the *node* executable in the **CustomNodePath** constant in the **_UseMe** > **Configuration** folder.
190201

191-
#### Enabling the DocGen Request Handler {#setup-inbound-rules}
202+
##### Enabling the DocGen Request Handler {#setup-inbound-rules}
192203

193204
In case you deploy on [Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/), you need to add the following rules when configuring the [reverse proxy inbound rules](/developerportal/deploy/deploy-mendix-on-microsoft-windows/#reverse-proxy-rules):
194205

0 commit comments

Comments
 (0)