Sealights Collector - Setup

Owned by Marc Amouyal
Last updated: Jul 15, 2024
2 min read

Downloading and Installing the Collector

Following are the pre-requisites for Https Collector:

  1. TLS settings should be enabled.

  2. The server should be accessible by Fully Qualified Domain Name (FQDN).

  3. TLS certificate for FQDN of the server where the collector is installed must be provided in config.yaml (See below)

Download the Sealights Collector Image

The Sealights Collector can be found at the following DockerHub link: https://hub.docker.com/r/sealights/on-prem-collector

docker pull sealights/on-prem-collector

Create your own Collector Image

  1. Download the Collector Binaries and Unzip :

    wget -nv https://agents.sealights.co/collector/0.42.0/collector.zip unzip -oq collector.zip #curl tool can also be used #curl -L "https://agents.sealights.co/collector/0.42.0/collector.zip" --output collector.zip

If you have a limitation accessing the endpoint agents.sealights.co and are limited to your specific server DNS, then you can also get the agent from https://{company}.sealights.co/collector/{version}/collector.zip
Replace {company} with your company DNS prefix and {version} with the specific version you want to use.

  1. Create a Dockerfile:

    FROM alpine:latest WORKDIR /collector COPY collector collector CMD ["./collector","serve"]

  2. Build the Image :

Setting up the HTTPS Collector

The following is a sample configuration that can be used to run the HTTPS Collector using Docker:

  1. Create a file called config.yaml with the following content

  1. Run the Collector using Docker:

  • Open https://<ServerFQDN>:16500 in your browser and if everything worked as expected you should be redirected to your Sealights Dashboard.

  • You should see the Collector entry in the Cockpit > Live Agents Monitor

Enabling Proxy functionality (Optional)

When the collector needs to serve other agents' functionalities like config and scan commands (besides coverage collection), you must enable its proxy service according to the additional settings below.
Please notice the port must be different from the collector service. For example below, port 16501 for proxy versus port 16500 for collector.

 

Configuration File Reference