New: Terraform Provider & Linux Private Checkpoints. See more.

  1. Support
  2. Knowledge base
  3. Synthetic Monitoring
  4. Checkpoints
  5. Private locations
  6. Install a private checkpoint

Install a private checkpoint

Tip: If you’re just getting started with Private locations, we recommend that you read the Private locations overview to understand its features and key functions.

This article explains how to set up and start a Docker-based private checkpoint.

Before installation, ensure that all the requirements and settings are met. Uptrends will provide you with all the necessary files to get started.

Installation steps

After you create a private location, two checkpoints are automatically added by default. You can install and host these private checkpoints using Linux or Windows operating systems.

Install private checkpoint for Linux (Docker Compose)

To install a private checkpoint using a script:

  1. Go to Private locations.
  2. If you haven’t added any Private locations, click Add location. Once added, two checkpoints will be included by default.
  3. Click the Private location’s checkpoint name.
  4. Select Linux (Docker Compose) from the Host Operating System dropdown.
  5. Click Download installation archive.
Important: Keep in mind that the downloaded archive only contains the specific private checkpoint you selected from the two default options. Your archive file has a file name UptrendsCheckpoints<checkpoint-name>, where <checkpoint-name> is the name of your checkpoint.

  1. Install Docker engine and Docker compose for your distribution.

  2. Run mkdir /opt/uptrendscheckpoint to create a new directory in the /opt directory.

  3. Unzip the downloaded file and place its contents in the /opt/uptrendscheckpoint directory.

  4. In the /opt/uptrendscheckpoint directory:

    a. Run install-checkpoint.sh to start the installation.

    b. Run docker compose up -d to start running the private location.

The checkpoints are now available and can be selected in the monitor’s Checkpoints tab. You can also view the checkpoints in the Check details dialog when running a quick test directly from the monitor using Test now.

To run a private checkpoint on Kubernetes, refer to the instructions below.

To install certificates in Private locations, see Install certificates in Private locations.

Install private checkpoint for Windows

To install a private checkpoint using a script:

  1. Go to Private locations.
  2. If you haven’t added any Private locations, click Add location. Once added, two checkpoints will be included by default.
  3. Click the Private location’s checkpoint name.
  4. Select any Windows operating system from the Host Operating System dropdown.
  5. Click Download installation archive.
Important: Keep in mind that the downloaded archive only contains the specific private locations checkpoint you selected from the two default options. Your archive has a file name UptrendsCheckpoints<checkpoint-name>, where <checkpoint-name> is the name of your checkpoint.
  1. Unzip the downloaded file in the folder where you want to install the private checkpoint.
  2. To prevent screenshots from uploading to the cloud, edit the docker-compose file after downloading and extracting the files.
Important: Depending on your company’s policies, you might need to unblock all the Powershell script files (*.ps1) in the zip folder before running them. For more information, see the instructions on how to unblock files.
  1. Open PowerShell as Administrator.
  2. Run ./install-checkpoint.ps1 in the Uptrends unzip directory. This restarts the server. The script will configure a task that runs once every hour to check the Uptrends containers for updates.

The checkpoints are now available and can be selected in the monitor’s Checkpoints tab. You can also view the checkpoints in the Check details dialog when running a quick test directly from the monitor using Test now.

To install certificates in Private locations, see Install certificates in Private locations.

Run a private checkpoint on Kubernetes

After installing a private checkpoint for Linux (Docker Compose), you can download the Kubernetes deployment package for your private checkpoints.

From the Private locations menu, select Linux (Kubernetes) from the Host Operating System dropdown and download the package. This package provides a starting point for your checkpoint setup and includes service and deployment descriptions for two private checkpoint services.

Ensure that you review the configuration files in the package. You may need to adjust these files to fit your environment.

To set up a single private checkpoint in an existing Kubernetes cluster:

  1. Open your terminal and run the kubectl create secret command. A similar example is provided in the readme.md file of the installation package. This adds pull credentials to the private Uptrends container repository.

  2. Run kubectl apply -f . from the directory with the service and deployment YAML files. This creates and starts the required services.

  3. Run kubectl get services to verify that the checkpoint and transaction processor services are created.

Important: Keep in mind that the downloaded archive only contains the specific private checkpoint you selected from the two default options. Your archive has a file name UptrendsCheckpoints<checkpoint-name>, where <checkpoint-name> is the name of your checkpoint.

Monitoring your private checkpoint

Uptrends will make changes to your account to better assist you in monitoring your private checkpoints. Please ensure that all your private checkpoint’s servers, firewall, internet connection, and other supporting systems remain accessible.

During the private checkpoint setup, Uptrends will add additional monitors and configurations. Please do not delete or modify anything in your account.

For more information, refer to the How to use Private locations knowledge base article.

By using the Uptrends website, you consent to the use of cookies in accordance with our Cookie Policy.