Skip to content

Commit 6b7c71e

Browse files
Merge pull request mendix#10476 from ozgeMendix/uia-1305-update-docgen-path-section
[UIA-1305] Update /docgen/ path configuration section
2 parents 311f3de + ed45057 commit 6b7c71e

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

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

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -116,31 +116,40 @@ 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](/developerportal/deploy/environments/#access-restriction-profiles) 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

123-
* Go to the [Nodes](https://cloud.home.mendix.com/) page, then in the **My Nodes** list, find the desired app, and then click **Environments**.
124-
* Alternatively, go to [Apps](https://sprintr.home.mendix.com), then in the **My Apps** list, find the desired app, and then click **Environments**.
123+
* Go to the [Nodes](https://cloud.home.mendix.com/) page, then, in the **Public Cloud - Nodes** list, find the desired app, then click **Environments**.
124+
* Alternatively, go to [Apps](https://sprintr.home.mendix.com), then in the **My Apps** list, find the desired app, then click **Environments**.
125125

126-
The app's **Environments** page opens. The **Deploy** tab shows a list of available environments for your app.
126+
The app's **Environments** page opens. The **Overview** tab shows a list of available environments for your app.
127127

128-
2. On the **Deploy** tab, click **Details** for the respective environment.
128+
2. On the **Overview** tab, click **Details** for the respective environment.
129129

130130
3. In the specific **Environment Details** page, select the **Network** tab.
131131

132132
4. Scroll down to **Path Based Access Restrictions** and click **Add**. The **Edit Path Based Access Restriction** dialog box opens.
133133

134134
5. Fill in the fields as follows:
135135
* In the **Path** field, enter */docgen/*.
136-
* From the **New Restriction Type** drop-down list, select *Allow all access*.
136+
* From the **New Restriction Type** drop-down list, select one of the following options:
137+
138+
* **Allow all access** – Allows unrestricted bidirectional access to the `/docgen/` path. This is less secure and gives full internet access to this path.
139+
* **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 bidirectional access to the `/docgen/` path.
140+
To configure the required IP addresses, follow the [Allowing the Document Generation Service IP Addresses](#allow-ip) section.
141+
For more information on managing access restriction profiles, refer to [Access Restrictions](/developerportal/deploy/access-restrictions/).
137142

138143
6. Click **Save**. The **/docgen/** path is added to the list.
139144

140145
7. Restart your application for the new request handler to take effect.
141146

142147
8. Now you can [register your app environments](#register-app).
143148

149+
#### Allowing the Document Generation Service IP Addresses {#allow-ip}
150+
151+
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.
152+
144153
#### Registering Your App Environments {#register-app}
145154

146155
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.
@@ -155,9 +164,6 @@ To allow the module to send and receive document generation requests on your Men
155164

156165
{{% 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 %}}
157166

158-
#### Allowing the Document Generation Service IP Addresses {#allow-ip}
159-
160-
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.
161167

162168
### Running on self-hosted for airgapped and on-premises {#run-private-service-and-on-premises}
163169

0 commit comments

Comments
 (0)