Skip to content

Commit fdd4208

Browse files
committed
TW review
1 parent cbb3bcd commit fdd4208

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

content/en/docs/marketplace/platform-supported-content/services/private-service.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,13 @@ The following artifact is available for installing the service:
6363
Follow these steps to install the service through Docker:
6464

6565
{{% alert color="info" %}}
66-
If you are using a self-signed certificate in your environment, skip the below steps and see [Importing a Self-Signed Certificate](#importing-a-self-signed-certificate).
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.
6767
{{% /alert %}}
6868

6969
1. Pull the Docker image using the following command: `docker pull private-cloud.registry.mendix.com/mendix/document-generation-service:latest`.
7070
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`.
7171

72-
The `latest` tag will use the most recent released version of the service. If you would like to use a specific version, replace `latest` tag 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/).
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/).
7373

7474
#### Setting Up a Health Check (Optional)
7575

@@ -118,15 +118,15 @@ When using Docker to run the image, add the configuration using the provided env
118118
|----------------------|---------------|-------------|
119119
| `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. |
120120
| `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. |
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.</p> <p> Alternatively, for better security, you can provide your certificates to the service, see [Importing a Self-Signed Certificate](#importing-a-self-signed-certificate).</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>|
122122

123123
### Importing a Self-Signed Certificate {#importing-a-self-signed-certificate}
124124

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 CA.
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).
126126

127127
Follow these steps:
128128

129-
1. **Create a Dockerfile** (for example, `Dockerfile.import-cert`) with the following content:
129+
1. Create a Docker file, such as `Dockerfile.import-cert`, with the following content:
130130

131131
```dockerfile
132132
FROM private-cloud.registry.mendix.com/mendix/document-generation-service:latest
@@ -166,23 +166,23 @@ Follow these steps:
166166
CMD [ "node", "bundle.js" ]
167167
```
168168

169-
1. **Build the Docker image** with your certificate:
169+
1. Build the Docker image with your certificate:
170+
170171
```bash
171172
docker build -f Dockerfile.import-cert --build-arg CERT_FILE_PATH=<path-to-your-ca.crt> -t document-generation-service-with-cert .
172173
```
173174

174-
1. **Run the container** as usual:
175+
1. Run the container as usual:
176+
175177
```bash
176178
docker run -p 8085:8085 --name document-generation-service-with-cert
177179
```
178180

179-
**Note:** Replace `<path-to-your-ca.crt>` with the path to your self-signed certificate `.crt` or `.pem` file.
181+
Replace `<path-to-your-ca.crt>` with the path to your self-signed certificate's `.crt` or `.pem` file.
180182
181-
This approach ensures the service trusts your self-signed certificate for secure connections.
183+
This approach ensures that the service trusts your self-signed certificate for secure connections.
182184
183-
{{% alert color="info" %}}
184-
If this self-signed certificate is all you need for the service to trust, Then it's best to disable the flag `ACCEPT_INSECURE_CERTIFICATES` by setting the value to `false`.
185-
{{% /alert %}}
185+
If you only need the service to trust this self-signed certificate, Mendix recommends setting the `ACCEPT_INSECURE_CERTIFICATES` variable to `false`.
186186
187187
## Configuring your Mendix Apps
188188

0 commit comments

Comments
 (0)