Skip to content

Commit 4629cd6

Browse files
Merge pull request #10685 from mendix/kk-pmp-doc-gen
PMP PDF Doc Gen
2 parents 60e629b + 71e07ad commit 4629cd6

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

content/en/docs/private-platform/pmp-quickstart.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -436,6 +436,32 @@ To enable Maia for Private Mendix Platform, perform the following steps:
436436
437437
If you want to uninstall Maia, you must do it manually, by running the following command: `helm unstall maia-appgen -n=< maia namespace>`.
438438
439+
### Installing PDF Document Generation for the Private Mendix Platform
440+
441+
The PDF Document Generation module allows you to generate pixel-perfect PDF documents based on regular pages in your app.
442+
443+
To enable PDF Document Generation for Private Mendix Platform, perform the following steps:
444+
445+
1. Download the *document-generation-service.zip* file from your Private Mendix Platform download portal.
446+
2. Unzip the *document-generation-service.zip* file.
447+
3. Copy the *document-generation-service.zip* directory the *images* sub-directory of the installer by running the following command: `cp -r maia-appgen-pmp <your installer>/pmp-binary-linux/images`
448+
4. Upload the directory to your private registry by using the `installer init` command.
449+
5. Run the following command: `./installer component -n=<Private Mendix Platform namespace>`. PDF Document Generation can be installed at the same namespace as Private Mendix Platform, or at any other namespace.
450+
6. In the **Components at PMP ns** section, select **PDF Gen**.
451+
7. Configure the following settings:
452+
453+
* **Namespace** - The namespace where PDF Document Generation will installed
454+
* **Image Prefix** - The registry and namespace (if it exists) where the *document-generation-service* image is located
455+
* **Image Name** - The image name, for example, *document-generation-service*
456+
* **Image Tag** - The image tag of the AppGen image, for example, *1.0.2*
457+
458+
#### Uninstalling PDF Document Generation
459+
460+
If you want to uninstall PDF Document Generation, perform the following steps:
461+
462+
1. Unstall PDF Document Generation from its namespace by running the following command: `helm uninstall mx-private-document-generation -n=<PDF Document Generation namespace>`.
463+
2. Remove the PDF data from the `pmp-component-config` configmap in your Private Mendix Platform namespace by running the following command: `kubectl edit configmap/pmp-component-config -n=<Private Mendix Platform namespace>`.
464+
439465
### Adding the Svix and PCLM Components After Installing the Private Mendix Platform
440466
441467
To ensure that the svix and PCLM components work correctly, you should install them before you install the Private Mendix Platform itself. If you want to add a component after the Platform installation (for example, if you want to install svix because you decided to enable webhooks), you must perform the following steps:

0 commit comments

Comments
 (0)