Skip to content

Commit 9086f16

Browse files
committed
[UIA-1274] Highlight private PDF service
1 parent 6526cc5 commit 9086f16

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

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

Lines changed: 18 additions & 8 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.
@@ -72,7 +73,8 @@ Follow the instructions in [How to Use Marketplace Content](/appstore/use-conten
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+
2. [Running on self-hosted for airgapped and on-premises](#run-private-service-and-on-premises) using a local version of the PDF service. This option is available for apps that are deployed to the following environments:
77+
* [Private PDF Document Generation Service](#run-private-service)
7678
* [Microsoft Windows](/developerportal/deploy/deploy-mendix-on-microsoft-windows/)
7779
* [Linux](/developerportal/deploy/linux/)
7880

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

157159
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.
158160

159-
### Running On-Premises {#run-on-premises}
161+
### Running on self-hosted for airgapped and on-premises {#run-private-service-and-on-premises}
162+
163+
#### Running Private PDF Document Generation Service {#run-private-service}
164+
165+
When access to the public Mendix PDF generation service is restricted, particularly in isolated or air-gapped environments, Mendix offers a privately hosted, Docker containerized PDF Document Generation service as an alternative.
166+
167+
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/).
168+
169+
#### Running On-Premises {#run-on-premises}
160170

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

163173
1. Make sure that you have the prerequisite software installed.
164174
2. Configure the module to use the local service.
165175
3. Enable the DocGen request handler.
166176

167-
#### Installing the Prerequisite Software {#install-prerequisites}
177+
##### Installing the Prerequisite Software {#install-prerequisites}
168178

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

171-
##### Chromium
181+
###### Chromium
172182

173183
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/)).
174184

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

177-
##### Node.js
187+
###### Node.js
178188

179189
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.
180190

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

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

185195
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.
186196

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

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

191-
#### Enabling the DocGen Request Handler {#setup-inbound-rules}
201+
##### Enabling the DocGen Request Handler {#setup-inbound-rules}
192202

193203
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):
194204

0 commit comments

Comments
 (0)