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
Copy file name to clipboardExpand all lines: content/en/docs/marketplace/platform-supported-content/services/private-service.md
+72-5Lines changed: 72 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,16 +62,19 @@ The following artifact is available for installing the service:
62
62
63
63
Follow these steps to install the service through Docker:
64
64
65
-
1. Pull the Docker image using the following command: `docker pull private-cloud.registry.mendix.com/mendix/document-generation-service:<tag>`.
66
-
2. Run the Docker container using the following command: `docker run -p 8085:8085 --name document-generation private-cloud.registry.mendix.com/mendix/document-generation-service:<tag>`. This creates a Docker container, which is exposed on port `8085`.
65
+
{{% alert color="info" %}}
66
+
If you are using a self-signed certificate in your environment, skip these steps and refer to the [Importing a Self-Signed Certificate](#importing-a-self-signed-certificate) section.
67
+
{{% /alert %}}
67
68
68
-
The `<tag>` component must be replaced with the version of the service, such as `1.0.0`. You can find all versions and their release notes in the [Private PDF Document Generation Service Release Notes](/releasenotes/marketplace/private-service/).
69
+
1. Pull the Docker image using the following command: `docker pull private-cloud.registry.mendix.com/mendix/document-generation-service:latest`.
70
+
2. Run the Docker container using the following command: `docker run -p 8085:8085 --name document-generation private-cloud.registry.mendix.com/mendix/document-generation-service:latest`. This creates a Docker container, which is exposed on port `8085`.
71
+
72
+
The `latest` tag allows you to use the most recent released version of the service. If you want to use a specific version, replace `latest` with the desired version, such as `1.0.0`. You can find all versions and their release notes in the [Private PDF Document Generation Service Release Notes](/releasenotes/marketplace/private-service/).
69
73
70
74
#### Setting Up a Health Check (Optional)
71
75
72
76
If you need to set up a health check, you can use the health check endpoint included in the service, at the `/health` path. This endpoint returns the `200` status code and the `OK` message if everything is working correctly.
73
77
74
-
75
78
### Isolation
76
79
77
80
Requests share the same container resources, which has the following implications:
@@ -115,7 +118,71 @@ When using Docker to run the image, add the configuration using the provided env
|`MAX_DOCUMENT_SIZE`|`25000000` (25 MB) | The maximum size for PDF documents generated using the service. When a PDF exceeds this file size, the request is aborted. |
117
120
|`MAX_PAGE_RENDERING_TIME`|`30000` (30 seconds) | The maximum time to wait for the page to finish loading and rendering. If loading the page exceeds this time, a [Wait for Content](/appstore/modules/document-generation/#wait-for-content-exception) exception is sent to the module. |
118
-
|`ACCEPT_INSECURE_CERTIFICATES`|`false`| <p> Allows the use of untrusted certificates, such as when using self-signed certificates.</p> <p> **Warning:** This disables certificate validation, and allows the use of invalid certificates. Be aware of any resulting security risks.</p> |
121
+
|`ACCEPT_INSECURE_CERTIFICATES`|`false`| <p> Allows the use of untrusted certificates, such as when using self-signed certificates.</p> <p> **Warning:** This disables certificate validation, and allows the use of invalid certificates. Be aware of any resulting security risks. Alternatively, for better security, you can provide your certificates to the service. For details, refer to the [Importing a Self-Signed Certificate](#importing-a-self-signed-certificate) section.</p>|
122
+
123
+
### Importing a Self-Signed Certificate {#importing-a-self-signed-certificate}
124
+
125
+
If your environment uses a self-signed certificate, you can extend the PDF Document Generation service Docker image to trust this certificate. This is required for secure communication when the service needs to connect to endpoints using your custom Certificate Authority (CA).
126
+
127
+
Follow these steps:
128
+
129
+
1. Create a Docker file, such as `Dockerfile.import-cert`, with the following content:
130
+
131
+
```dockerfile
132
+
FROM private-cloud.registry.mendix.com/mendix/document-generation-service:latest
133
+
134
+
ARG CERT_FILE_PATH
135
+
136
+
RUN echo "Check if CERT_FILE_PATH is provided"
137
+
RUN if [ -z "$CERT_FILE_PATH" ]; then \
138
+
echo "ERROR: CERT_FILE_PATH build argument is required"; \
139
+
exit 1; \
140
+
fi
141
+
142
+
RUN echo "Copy certificate as DocumentGeneration_CA"
0 commit comments