Install Remediate from a custom container registry

You can also use a custom Docker registry to install Puppet Remediate.

Before you begin

Prior to installing Remediate using a custom Docker registry, check that you have carried out the following prerequisite tasks:

  • Make sure you meet the system requirements for installing and running Remediate, and that you have received your license.
  • Ensure that Docker and Docker Compose are installed on the nodes where you want to install the Remediate images. If you are installing Docker Compose on Windows, ensure that you create a new Windows environment variable called COMPOSE_CONVERT_WINDOWS_PATHS and set it to 1. This enables path conversion from Windows-style to Unix-style in volume definitions.
  • Ensure that your license is added to the nodes where you want to install the Remediate images.
  • If you use a custom Docker registry to store the Remediate Docker images, you must set the REGISTRY environment variable to point to the URL of your custom docker registry, e.g.:

    In this example, Remediate will contact to download the docker images it needs.

  1. On the node where you want to install Remediate, initialize a swarm by running the following command:
    docker swarm init
  2. Download the Remediate Docker Compose file to the same directory as your license.
    Note: If you want to manually validate the signature, see Verify Docker Compose file for more information.
  3. Run the following command ⁠(replacing your-license.json with your own license):
    docker-compose run remediate start --license-file your-license.json

    The container images are pulled from the custom registry location specified by your REGISTRY environment variable.

    CAUTION: If you start Remediate without a license file you will not have access to the full range of Remediate functionality. If you started Remediate without a license file in error, simply stop the application by issuing the following command:
    docker-compose run remediate stop

    And start Remediate again using the --license-file parameter as outlined above.

  4. To check that all the images have downloaded and that the containers have started running, run the following command:
    docker ps
  5. To access Remediate on a local workstation, the URL is https://localhost:8443, or port 8443 on the host where you installed Remediate.
    Note: When you first open the site, a warning message will be displayed that indicates the site certificate is untrusted. This is because Remediate uses a self-signed certificate and is expected behavior. Accept the certificate to continue.
  6. Read and accept the software license agreement.
  7. Sign in to Remediate.

    For default usernames and passwords, see Managing user access.