Skip to content

Commit 344594c

Browse files
committed
[UIA-1305] Fix /docgen/ path configuration section and reorder runing on mendix cloud section
1 parent aa2f83c commit 344594c

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

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

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ To allow the module to send and receive document generation requests on your Men
116116

117117
2. Make sure that you have the application [deployed to the desired Mendix Cloud](/developerportal/deploy/mendix-cloud-deploy/deploying-an-app/).
118118

119-
3. To allow the module to send and receive document generation requests in your Mendix Cloud environments, enable the DocGen request handler as follows:
119+
3. If the app does not have any access restrictions, you can skip this step. If the app has a configured Access Restriction Profile that disables communication with the internet, you need to make sure that the app can communicate with the Document Generation service in the Public Cloud. To allow the module to send and receive document generation requests in your Mendix Cloud environments, enable the DocGen request handler as follows:
120120

121121
1. Go to the **Environments** page for the app as follows:
122122

@@ -134,15 +134,19 @@ To allow the module to send and receive document generation requests on your Men
134134
5. Fill in the fields as follows:
135135
* In the **Path** field, enter */docgen/*.
136136
* From the **New Restriction Type** drop-down list, select one of the following options:
137-
* **Allow all access** Allows unrestricted bi-directional access to the `/docgen/` path.
138-
* **Custom Profile for Client Certificates and/or IP ranges** Applies a custom access restriction profile to the `/docgen/` path. When you select this option, choose your access restriction profile from the **New Restriction Profile** drop-down list. Ensure that the selected profile allows bi-directional access to the `/docgen/` path. For more information on creating and managing access restriction profiles, see [Access Restrictions](/developerportal/deploy/access-restrictions/).
137+
* **Allow all access** - Allows unrestricted bi-directional access to the `/docgen/` path. This is less secure and will enable the internet to reach the app on this path.
138+
* **Custom Profile for Client Certificates and/or IP ranges** - Applies a custom access restriction profile to the `/docgen/` path. When you select this option, choose your access restriction profile from the **New Restriction Profile** drop-down list. Ensure that the selected profile allows bi-directional access to the `/docgen/` path. To configure the required IP addresses, follow the [Allowing the Document Generation Service IP Addresses](#allow-ip) section. For more information on managing access restriction profiles, see [Access Restrictions](/developerportal/deploy/access-restrictions/).
139139

140140
6. Click **Save**. The **/docgen/** path is added to the list.
141141

142142
7. Restart your application for the new request handler to take effect.
143143

144144
8. Now you can [register your app environments](#register-app).
145145

146+
#### Allowing the Document Generation Service IP Addresses {#allow-ip}
147+
148+
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.
149+
146150
#### Registering Your App Environments {#register-app}
147151

148152
1. Add the snippet **Snip_AppRegistration** to a page in your app that is accessible to users with the **Administrator** module role set in the **DocumentGeneration** module. The snippet can be found in the **_UseMe** > **Admin** folder of the **DocumentGeneration** module.
@@ -157,9 +161,6 @@ To allow the module to send and receive document generation requests on your Men
157161

158162
{{% alert color="info" %}}Each of your app environments needs to be registered separately. A successful app registration is limited to the app URL that was provided during the registration. Note that a change in the app URL, or restoring a database backup from one environment to another, will require you to register the affected app environments again.{{% /alert %}}
159163

160-
#### Allowing the Document Generation Service IP Addresses {#allow-ip}
161-
162-
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.
163164

164165
### Running on self-hosted for airgapped and on-premises {#run-private-service-and-on-premises}
165166

0 commit comments

Comments
 (0)