Install certificates in Private locations

When setting up your Docker-based Private Location , you may need to install certificates to establish trust and authenticate connections with the website or web service you’re monitoring.

The following types of certificates are available for installation:

• Client certificates (PKCS #12)
• Intermediate Certificate Authority (CA) certificates (PKCS #7)
• Root Certificate Authority (CA) certificates (PKCS #7)

Note that the Uptrends Docker-based installation zip file contains a Certificates folder. Inside, you’ll find subfolders for each supported certificate type, where certificates can be installed as described below.

Install certificates on a Docker-based Private location

This section is an optional installation guide for certificates on Docker-based Private locations. These steps are only needed if any of your applications under test require installing a certificate.

Before installing the certificates, ensure you’ve followed the installation steps for Docker-based Private locations .

Install Certificate Authority (CA) certificates

To install CA certificates:

1. Open the folder containing your private location installation. You’ll find several files included by default, such as the docker-compose YAML file and Windows PowerShell scripts. These files are essential for the installation process.

2. Open the Certificates folder. This folder contains three subfolders and a README Markdown file.

3. Place your CA certificates in the appropriate Certificates subfolders:

• Intermediate folder — for all the Intermediate Certificate Authority (CA) certificates (PKCS #7) files.
• Root folder — for all the Root Certificate Authority (CA) certificates (PKCS #7) files.

4. Restart the Uptrends checkpoint software by running the update-images.ps1 script from the installation root directory.

Install Client certificates

Note that the Client certificates in Multi-step API (MSA) monitors and Client certificates for Private locations are unrelated and serve for different purposes.

To install Client certificates:

1. Open the folder containing your private location installation. You’ll find several files included by default, such as the docker-compose YAML file and Windows PowerShell scripts. These files are essential for the installation process.

2. Open the Certificates folder. This folder contains three subfolders and a README Markdown file.

3. Place your Client certificate in the Client folder.

4. In the Client folder, create a JSON file called clientCertificates.json. This JSON file should list all your Client certificates. Otherwise, proceed to the next step.

• Copy and edit the JSON template to get started:

[
    {
        "File": "my-first-client-cert.p12",
        "Password": "letmein",
        "UrlPatterns": ["https://fake.sub.domain.example.com"]
    },
    {
        "File": "AcmeCert.pfx",
        "Password": "anvil123",
        "UrlPatterns": ["https://client.acmecorp.fake:1234", "[*.]acmecorp.real"]
    }
]

Notice that the JSON snippet consists of two Client certificates. Each Client certificate is represented by a JSON object with three key-value pairs. The first certificate, my-first-client-cert.p12, is allowed to be used for a specific subdomain. While the second certificate, AcmeCert.pfx, is allowed to be used for the client’s subdomain of acmecorp.fake when connecting to HTTPS port 1234, or when visiting acmecorp.real or any of its subdomains.

Edit the following values based on your requirements:

• File — the filename and file extension of your Client certificate.
• Password — the password needed to access the data in the certificate archive, such as the private key.
• UrlPatterns — the list of allowable URL domains or subdomains that will use the Client certificate. This list can consist of multiple URL patterns which can be a single domain, subdomain, or a wildcard for a domain and all of its subdomains. To learn more, refer to Enterprise policy URL pattern format .

5. Restart the Uptrends checkpoint software by running the update-images.ps1 script from the installation root directory.

6. Verify that both the old and new certificates are recognized and installed correctly. If you encounter any issues, do a basic troubleshooting:

• Verify that the JSON filename is correct.
• Ensure that all JSON key-value pairs adhere to correct JSON syntax.
• Check for any misconfigurations or permission issues.