Skip to main content

​
Prerequisite

This section covers all requirements to run the essentry cloud connector.

​
Supported Configurations

To enable essentry to integrate with a locally or remotely installed system (for example an on-premise access control system), one of the following configurations are required. The essentry cloud connector is:
  1. installed on the same system as the integrated system.
  2. installed on a satellite system, able to communicate with the integrated system.

​
Local System Hardware Requirements

Hardware ComponentMinimalRecommendedDescription
Hard drive space5GB (free)-Cloud connector software, logs, and backups
CPUDual CoreQuad CoreCloud connector heavily relies on multi-threading
Memory (RAM)500 MB (available)2 GB (available)Depends on traffic
Internet connection speed5 Mbit/s> 10 Mbit/sDepends on the traffic, affects backend synchronization speed

​
Local System Software/Firewall Requirements (essentry cloud connector)

  1. Supported Operating Systems: https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md
    1. Windows 10 / 11 / Server 2012 / other
  2. .NET Runtime 8 (or higher) and ASP .NET Core Runtime 8 (or higher)
    1. Download .NET 8.0 (Linux, macOS, and Windows)
  3. Open Ports: 443 (HTTPS) to *.essentry.com
The simplified architecture overview for the essentry cloud connector is shown in the following diagram:

​
Windows Installation

This section covers installing, upgrading, and removing the essentry cloud connector on a Windows system. The installation files are packed as a zip file and extract to the following file structure:
  1. bin/ - the folder contains executable and configuration files
  2. install.ps1 - Script to install the essentry cloud connector
  3. start.ps1 - Script to start the essentry cloud connector
  4. stop.ps1 - Script to stop the essentry cloud connector
  5. uninstall.ps1 - Script to remove the essentry cloud connector (does not remove any files or directories)

​
Installation

Please start a PowerShell console with Administrator privileges.
  1. Navigate to the extracted essentry cloud connector files folder: cd <path>
  2. Run the installation script: ./install.ps1
The essentry cloud connector is now registered as a Windows service with automatic start and failure recovery every minute. The service name starts with essentry_agent_. To determine whether everything is running and configured correctly, please check if the service is in the Running state. In addition, essentry can check for any error report that may be caused by an incorrect or incomplete configuration and help to resolve it.

​
Upgrading

Please start a PowerShell console with Administrator privileges.
  1. Navigate to the initial installation directory of the essentry Cloud Connector: cd <path>
  2. Run the uninstallation script: ./uninstall.ps1
  3. Extract the new files and replace the old files in the initial installation directory.
  4. Run the installation script: ./install.ps1

​
Uninstallation

Please start a PowerShell console with Administrator privileges. Navigate to the initial installation directory of the essentry cloud connector: cd <path> Run the uninstall.ps1 script: ./uninstall.ps1 Delete all files in the initial installation directory and optionally from the configured log directory.