Download and Installation

Download and Installation

This article outlines the process for downloading and installing the Endpoint Sensor (EES) packages across various operating systems, including Windows, Linux, and macOS. It provides step-by-step instructions for acquiring the necessary files, performing the installation, and registering devices with the Eclypsium Analytics Service. Follow these guidelines to ensure proper setup and functionality of the sensor.

1. Downloading the EES Packages
Navigate to the Download page under Deployment to download the EES packages for the Operating System(s) used on the target systems to be monitored.
This page provides instructions for installation via the OS-specific installer or the command line.
  1. Windows:
    If using the Windows installer, copy and paste the Device Registration Token and Domain values, which are available under Instructions (GUI).


2. Installing the Sensor
The Sensor consists of a userspace application and a kernel module (driver). The installation process varies based on the operating system:

  1. Windows:
    Install the complete Endpoint Sensor using an MSI or a bundled EXE file. Example:
    Eclypsium-X.X.X.exe /q /norestart
  1. Linux:
    There are separate packages for the Eclypsium Application and Driver. Both are required for the Endpoint Sensor to function. For Debian-based distributions, use:
    # dpkg -i eclypsiumapp-X.X.X.deb eclypsiumdriver-X.X.X_all.deb
  1. macOS:
    Install the complete Endpoint Sensor using a .pkg package:
    # installer -pkg Eclypsium-X.X.X.pkg -target /

Make sure you replace X.X.X with the sensor version.

3. Sensor Installation Locations
Once installed, the Sensor will be located in the following directories:
  1. Windows: [ProgramFiles]\Eclypsium\EclypsiumApp.exe
  2. Linux: /usr/bin/EclypsiumApp
  3. macOS: /usr/local/bin/EclypsiumApp

4. Register the Device with the Analytics Service
To register the device, run the following commands:
  1. Windows (as Administrator):
    EclypsiumApp.exe -s2 DOMAIN REGISTRATION_TOKEN  
  2. Linux and macOS (as root):
    # EclypsiumApp -s2 DOMAIN REGISTRATION_TOKEN
Where:
  1. DOMAIN: The fully qualified domain name of the Eclypsium Analytics Service.
  2. REGISTRATION_TOKEN: The Host Registration Token.
This command will also perform a device scan and upload the results to the Analytics Service.
Notes
  1. Tab completion works only from the root/Administrator account.
  2. Once registered, the monitored device will appear in the Eclypsium Administration Console.
  3. You can also refer to the usage template when running the Sensor from the command line.