catchpoint/enterprise-light repository overview

⁠Enterprise Light Docker Deployment Instructions

⁠Prerequisites

Ensure Docker is properly installed. Follow the official Docker installation documentation to install it on your system - https://docs.docker.com/install/⁠⁠.

Catchpoint's docker image for Enterprise Light is available here: https://hub.docker.com/r/catchpoint/enterprise-light⁠

⁠Step 1: Pull the image from Docker Hub

Pull the latest docker image from Docker Hub. Use stable for the latest stable release, and preview for the latest preview version:

$ docker pull catchpoint/enterprise-light:preview

⁠Step 2: Create and run a container

Create a container from the image using the following arguments:

Example:

$ docker run --hostname=cp-ent-light-00 --name=cp-ent-light --env Node_InstanceId=123456QWERTY catchpoint/enterprise-light:preview

Overriding DNS in containers Docker Containers use the host's DNS settings by default. You can configure Catchpoint's docker container with a different set of DNS servers by using the --dns argument in the docker run command.  For example:

--dns=<<dns-server>>

If you need to add multiple DNS servers, repeat the command.  For example:

--dns=8.8.8.8 
--dns=8.8.4.4 

⁠Step 3: Activate the Container

To activate the container, follow the instructions here: Activating an Instance on Portal⁠⁠.

Note that you should use the Instance ID from the container as the MAC Address field in the Catchpoint Portal. You can get the required information for activation in the Catchpoint portal with the following command (note cp-ent-light is the container name in this example:

$ docker exec -t cp-ent-light catchpoint info
InstanceName: cp-ent-light-00
InstanceId: 123456QWERTY

⁠Automatic Activation

Additionally, it's also possible to have the container activate itself by using a REST API v2 key (found under Settings > API in the portal).

It's highly recommended to set the --env Node_InstanceId when using automatic activation.

Example:

$ docker run --hostname=cp-ent-light-00 --name=cp-ent-light-00 --env Node_InstanceId=123456QWERTY --env Node_ApiKey=${API_KEY} --env Node_Name="Z -cp-ent-light" catchpoint/enterprise-light:preview

This command would attempt to activate a brand new instance "cp-ent-light-00" under node "Z -cp-ent-light" with ID "123456QWERTY".

Note: If the instance already exists the command will complete successfully, even if the ID is different.