You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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
+
30
31
{{% 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 %}}
31
32
* 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.
32
33
* 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
*[Mendix on Kubernetes Connected](/developerportal/deploy/private-cloud/)
74
75
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)
@@ -156,39 +158,47 @@ To allow the module to send and receive document generation requests on your Men
156
158
157
159
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.
158
160
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}
160
170
161
171
To configure the module to generate documents on your on-premises environments, you need to perform the following steps:
162
172
163
173
1. Make sure that you have the prerequisite software installed.
164
174
2. Configure the module to use the local service.
165
175
3. Enable the DocGen request handler.
166
176
167
-
#### Installing the Prerequisite Software {#install-prerequisites}
177
+
#####Installing the Prerequisite Software {#install-prerequisites}
168
178
169
179
You should pre-install and actively maintain the following software. Mendix does not provide support for the installation, configuration, and maintenance of these packages.
170
180
171
-
##### Chromium
181
+
######Chromium
172
182
173
183
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/)).
174
184
175
185
{{% alert color="info" %}}Even though we advise using Chromium, you can also use Google Chrome instead. The configuration remains the same.{{% /alert %}}
176
186
177
-
##### Node.js
187
+
######Node.js
178
188
179
189
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.
180
190
181
191
{{% alert color="info" %}}Make sure that the Mendix Runtime has the applicable permissions to run the *node* executable.{{% /alert %}}
182
192
183
-
#### Configuring the Module to use the Local Service {#configure-local-service}
193
+
#####Configuring the Module to use the Local Service {#configure-local-service}
184
194
185
195
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.
186
196
187
197
2. Configure the path to the *chrome* executable in the **CustomChromePath** constant in the **_UseMe** > **Configuration** folder.
188
198
189
199
3. Configure the path to the *node* executable in the **CustomNodePath** constant in the **_UseMe** > **Configuration** folder.
190
200
191
-
#### Enabling the DocGen Request Handler {#setup-inbound-rules}
201
+
#####Enabling the DocGen Request Handler {#setup-inbound-rules}
192
202
193
203
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):
0 commit comments