Ekran System Deployment Guide
Ekran System Deployment Guide
Ekran System Deployment Guide
7
Deployment Guide
Table of Contents
About ........................................................................................................................................7
System Requirements ...........................................................................................................8
Program Structure ...............................................................................................................11
Deployment Process ...........................................................................................................13
Server and Database ...........................................................................................................14
About ....................................................................................................................................14
Database Types Comparison ............................................................................................ 14
High Availability Mode ........................................................................................................16
About .................................................................................................................................16
Standard and High Availability Modes Comparison ..................................................... 16
Installing Remote PostgreSQL Database Server ............................................................ 17
Installing/Uninstalling/Updating the Server .......................................................................18
Installing the Server ......................................................................................................... 18
Backing up Ekran Master Certificate.............................................................................. 23
Deleting Ekran Master Certificate .................................................................................. 27
Importing Ekran Master Certificate................................................................................. 27
Installing the Server in the Cloud ................................................................................... 28
Adding Server Executable to Windows Firewall ........................................................... 28
Using an External/Cloud-Based Server Computer ....................................................... 31
Updating the Server......................................................................................................... 32
Uninstalling the Server ....................................................................................................33
Changing Server Port for Client Connection ............................................................... 34
Moving Binary Data to Shared or Local Folder ................................................................ 34
Validating Monitoring Data .................................................................................................36
About .................................................................................................................................36
Validating Monitoring Data Using Hash Codes............................................................. 37
Signing Monitoring Data with Certificate........................................................................37
Editing Database Parameters ............................................................................................ 41
Management Tool.................................................................................................................42
About ....................................................................................................................................42
Management Tool Installation Prerequisites ....................................................................42
Prerequisites Overview ...................................................................................................42
Turning on Internet Information Service (IIS) ................................................................ 42
2
Turning on IIS for Windows 8 and Windows 7 ........................................................... 42
Turning on IIS for Windows Server 2008 R2 ............................................................. 43
Turning on IIS for Windows Server 2012 ...................................................................44
Installing .NET Framework.............................................................................................. 47
Configuring Internet Information Service (IIS)............................................................... 47
Using Certificates............................................................................................................. 51
Generating Self-Signed Certificate ............................................................................. 51
Exporting Self-Signed Certificate ................................................................................ 54
Importing Trusted Certificate ....................................................................................... 54
Adding Certificate to Trusted Root Certification Authorities .....................................55
Setting HTTPS Binding for a Default Web-Site ............................................................ 61
Installing/Uninstalling/Updating the Management Tool ................................................... 62
Installing the Management Tool ..................................................................................... 62
Adjusting Computer for Remote Access........................................................................64
Updating Management Tool ........................................................................................... 66
Uninstalling Management Tool ....................................................................................... 67
Opening Management Tool ............................................................................................... 67
Licensing ...............................................................................................................................68
General Licensing Information ........................................................................................... 68
About Serial Keys................................................................................................................ 68
About Update & Support Period ........................................................................................ 69
Viewing License State ........................................................................................................70
Activating Serial Keys Online ............................................................................................. 71
Adding Activated Serial Keys Offline................................................................................. 71
Deactivating Serial Keys ....................................................................................................73
Client License Management .............................................................................................. 74
Windows Clients...................................................................................................................76
About ....................................................................................................................................76
Monitoring via Windows Clients......................................................................................... 76
Installing Windows Clients .................................................................................................77
About .................................................................................................................................77
Setting up Environment for Remote Installation ........................................................... 77
Windows Client Installation Prerequisites ..................................................................77
Disabling Simple File Sharing in Windows XP .......................................................... 78
Disabling Sharing Wizard in Windows 8.1, Windows 8 and Windows 7 ................. 79
Checking System Services .......................................................................................... 80
3
Setting up Windows Vista, Windows XP, Windows Server 2003 Firewall .............. 81
Setting up Firewall for Windows 10, Windows 8.1, Windows 8, Windows 7,
Windows Server 2012, Windows Server 2008 .......................................................... 83
Installing Windows Clients Remotely via the Management Tool ................................ 86
About.............................................................................................................................. 86
Selecting Computers ....................................................................................................86
Remote Windows Client Installation Process ............................................................ 88
Remote Installation from an Existing .INI File ............................................................ 89
Installing Windows Clients Locally ................................................................................. 89
About.............................................................................................................................. 89
Windows Client Installation Package.......................................................................... 90
Generating Windows Client Installation Package...................................................... 97
Installing Windows Clients Locally with Custom Monitoring Parameters ................ 98
Downloading Windows Client Installation File (.exe) ................................................ 98
Installing Windows Clients Locally without .ini File ................................................... 98
Installation via Third Party Software .............................................................................. 99
Installing Windows Client on Amazon WorkSpace ....................................................... 99
Installing Windows Client Remotely Using PsExec ...................................................... 99
Cloning a Virtual Machine with Installed Client ........................................................... 100
Unassigning License on Virtual Machine Shutdown .................................................. 101
Golden Image Mode for the Server .......................................................................... 101
Unassigning License via the Script on the Client Side ........................................... 101
Updating Windows Clients ............................................................................................... 102
About ............................................................................................................................... 102
Windows Client Status after Server Update ................................................................ 103
Updating Windows Clients Automatically .................................................................... 103
Updating Windows Client Manually ............................................................................. 103
Reconnecting Windows Clients to Another Server ........................................................ 104
Uninstalling Windows Clients ........................................................................................... 104
About ............................................................................................................................... 104
Client Uninstallation Key ............................................................................................... 104
Uninstalling Windows Clients Remotely ...................................................................... 105
Uninstalling Windows Clients Locally .......................................................................... 105
Viewing Windows Clients ................................................................................................. 106
macOS Clients .................................................................................................................... 107
About .................................................................................................................................. 107
4
Monitoring via macOS Clients ......................................................................................... 107
Installing macOS Client .................................................................................................... 108
About ............................................................................................................................... 108
Downloading macOS Client Installation File ............................................................... 108
Installing macOS Clients ............................................................................................... 108
Uninstalling macOS Clients ............................................................................................. 109
About ............................................................................................................................... 109
Uninstalling macOS Clients Remotely ......................................................................... 109
Uninstalling macOS Clients Locally ............................................................................. 110
Viewing macOS Clients .................................................................................................... 110
Linux Clients ....................................................................................................................... 111
About .................................................................................................................................. 111
Monitoring via Linux Clients ............................................................................................. 111
Remote SSH Session Monitoring................................................................................. 111
Local Sessions Monitoring (for X Window System) .................................................... 111
Installing Linux Client ........................................................................................................ 112
About ............................................................................................................................... 112
Downloading Linux Client Installation File ................................................................... 112
Installing Linux Clients................................................................................................... 112
Updating Linux Clients...................................................................................................... 114
About ............................................................................................................................... 114
Linux Client Status after Server Update ...................................................................... 114
Updating Linux Clients Automatically .......................................................................... 114
Updating Linux Client Manually .................................................................................... 115
Uninstalling Linux Clients ................................................................................................. 115
Viewing Linux Clients........................................................................................................ 115
Tray Notifications Application ......................................................................................... 117
About .................................................................................................................................. 117
Installing/Uninstalling the Tray Notifications Application ............................................... 117
Installing the Tray Notifications Application................................................................. 117
Uninstalling the Tray Notifications Application ............................................................ 118
Troubleshooting ................................................................................................................. 119
Quick Access to Log Files ................................................................................................ 119
Database/Server ............................................................................................................... 119
Database/Server Related Issues ................................................................................. 119
Database/Server Related Error Messages ................................................................. 121
5
Management Tool ............................................................................................................. 123
Management Tool Related Issues ............................................................................... 123
Management Tool Error Messages.............................................................................. 125
Windows Client.................................................................................................................. 127
Checking that the Client Is Installed............................................................................. 127
Clients Installation/Uninstallation Issues and Error Messages .................................. 129
Linux Client ........................................................................................................................ 134
Checking the State of the Linux Client......................................................................... 134
Restarting Linux Client .................................................................................................. 134
6
About
7
System Requirements
Ekran System claims different system requirements for each of its components. Make sure your
hardware and software meet the following system requirements to avoid possible component
malfunctions.
8
[For accessing the Management Tool locally or remotely] One of the following browsers:
Google Chrome 37 or higher
Mozilla Firefox 32 or higher
Internet Explorer 10 or higher
Safari S6 and Safari S5
Opera 15 or higher
NOTE: The Management Tool might be opened in other browsers, but its compatibility with
other browsers is not guaranteed.
9
Distributor Base OS Versions Supported
openSUSE Suse Linux Enterprise Server 12(SP1, SP2, SP3), 11(SP2, SP3,
SP4)
The monitoring of graphical interface for X Window System is supported on the following
operating systems:
OS Versions Supported
Red Hat Red Hat 7.0 – 7.6, Red Hat 6.0 – 6.10
NOTE: When the Client is installed to the terminal server, hardware requirements depend on
the number of active user sessions and may increase drastically. For example, hardware
requirements for the Client deployed on the terminal server hosting 10 active user sessions
will be as follows:
Intel Core i3 or similar AMD CPU
2048 MB RAM
10
Program Structure
Ekran System Server (further referred to as Server): It is the main part of the Ekran
System used for storing the screenshots and associated information received from the
Clients. The work of the Server can be started or stopped via Server Tray.
Ekran System Windows Clients (further referred to as Windows Clients): Being hosted
on the remote computers, Windows Clients create screenshots with the defined
frequency and send them to the Server along with metadata information such as user
name, host name, activity time, active window titles, application names, URL addresses,
clipboard text data, keystrokes, etc. Managing the remote Windows Clients
configuration and settings is performed via the Management Tool.
Ekran System macOS Clients (further referred to as macOS Clients): Being hosted on
the remote computers, macOS Clients create screenshots with the defined frequency
and send them to the Server along with metadata information such as user name, host
name, activity time, active window titles, application names, URL addresses, etc.
Managing the remote macOS Clients configuration and settings is performed via the
Management Tool.
11
12
Deployment Process
The Ekran System installation consists of several steps:
1. Installing the Server: To deploy the system, first of all you need to install the Server. The
Server is used to store and process all records sent by the Clients hosted on the remote
computers. During the Server installation you can select the type of the database and define
administrator credentials.
NOTE: You can deploy the Ekran System in the High Availability mode, which allows you
to work with multiple Server instances in the Network Load Balancer cluster. This would
provide a high level of operational performance, which allows minimizing downtime and
service interruptions. Please refer to the High Availability Deployment Guide for more
information.
2. Completing Management Tool installation prerequisites: To install and run the Management
Tool, you need to turn on the Internet Information Service on your computer, add the self-
signed or trusted certificate to the Trusted Root Certification Authorities and set HTTPS
binding for a default web site (or any other IIS site).
3. Installing the Management Tool: The Management Tool is used to manage Users, Clients,
Alerts, and Database, as well as to view the monitored data received from Clients.
Connection with the Server is required for the Management Tool to operate.
4. Activating serial keys (adding activated serial keys): To be able to receive data from the
Clients, you need to license the Clients by activating purchased serial keys. You can also
activate an Enterprise serial key to get an access to the enterprise features of the Ekran
System during the unlimited period of time.
5. Installing Clients:
Installing Windows Clients: The Windows Clients are usually installed remotely via the
Management Tool. A Windows Client can be installed on any computer in the network.
Please note that several conditions have to be met for successful remote Client
installation.
Installing macOS Clients: The macOS Clients are installed locally.
Installing Linux Clients: The Linux Clients are installed locally.
6. Installing the Tray Notifications application: The Tray Notifications application can be
installed on any computer and as long as there is connection to the Server; the Tray
Notifications application displays notifications on all alert events received from Clients.
For more information, see the Tray Notifications application help file.
After installing all the system components, Ekran System is considered deployed and all its
features become available.
13
Server and Database
About
The Server is the main component of the system, which provides interaction between other
components. The Server stores all monitored data, user accounts, and system settings in the
database.
General
Remote ✔ ✔
access to
(a separate database engine that (a separate database engine that
database
can be deployed on a separate can be deployed on a separate
server) server)
Clustering ✔ ✔
support
(Primary-Standby)
Network ✔ ✔
drives (if mount as drive)
support
14
Feature MS SQL Database PostgreSQL Database
Performance
Requires ✔ ✔
additional
software
installation
Safety and security
Security High. Keystroke encryption is High. Keystroke encryption is
supported supported
Safety o Database corruption is unlikely o Database corruption is unlikely
o Replications o Replications
o Сan be managed via Microsoft
native tools
o Support scheduled
maintenance: reindexing, shrinking
etc.
15
Feature MS SQL Database PostgreSQL Database
NOTE: The High Availability mode is available only if you have an activated Enterprise serial
key.
Serial key types One of the following Enterprise serial key and one of the
serial keys: following keys:
Permanent Permanent
Trial Trial
Update and Update and support
support
Database type MS SQL or PostgreSQL MS SQL or PostgreSQL
16
Additional Software None NLB cluster
NOTE: We recommend using
Windows NLB. We cannot
guarantee the High Availability
Mode to function with other load
balancers correctly.
17
Installing/Uninstalling/Updating the Server
Installing the Server
To install the Server, do the following:
1. Run the EkranSystem_Server.exe installation file.
2. Click Next on the Welcome page.
3. Carefully read the terms of the End-User License Agreement and click I Agree.
4. On the Choose Components page, do one of the following and click Next:
In the drop-down list, select Ekran System Server.
Select Ekran System Server in the box.
5. On the Choose Install Location page, enter the installation path or click Browse to
navigate to the Server installation folder. Click Next.
18
6. On the Database Type page, select the type of database you want to use for storing
data. Click Next. See the Database Types Comparison chapter, to see the difference
and choose the proper type of the database.
NOTE: If you have already created database, select its type, and then define the
connection parameters for this database.
7. If you have selected the PostgreSQL database, on the PostgreSQL Server Database
Configuration page, define the connection parameters and then click Next.
19
Define the PostgreSQL Server instance name, which is the instance name
assigned to the TCP/IP port. Optionally, you can define the custom PostgreSQL
database port by entering it after the Server instance name and separating
with colon (e.g.,<server_instance_name>:<port>).
NOTE: If the default instance of the PostgreSQL is used, enter localhost in the
Server instance field.
Define the Database name for the database.
Define the User name and Password of a user account via which the
connection to the Server will be established.
NOTE: By default, it is a user with the login postgres and the password
defined during the PostgreSQL installation.
8. If you have selected MS SQL Server, on the MS SQL Server Database Configuration
page, define the connection parameters and then click Next.
Define the MS SQL Server instance name, which is the instance name assigned
to the TCP/IP port. Optionally, you can define the custom MS SQL database
port by entering it after the Server instance name and separating with comma
(e.g.,<server_instance_name>,<port>).
Define the Database name for the database.
Define the User name and Password of a user account via which the
connection to the Server will be established.
NOTE: You have to define either the SA credentials or the credentials of the
user with the dbcreator permission.
20
9. If you already have a database created manually or during the usage of previous
program versions, you will be offered to use it. If you want to use the existing
database, click Yes. In other case, click No and the new database will be created.
NOTE: If you click No, the existing database will be deleted.
10. On the Administrator password page, define the password for the administrator (the
default user of Ekran System with login admin and full permissions). Click Next.
21
11. On the Ekran System Client Uninstallation Key page, enter the key that will be used
during the Client local uninstallation and click Next. By default, the Uninstallation key
is allowed. You will be able to change this key via the Management Tool any time
later.
4. In the Add or Remove Snap-ins window, select Certificates and click Add.
23
5. In the Certificates Snap-in window, select the Computer account option and click Next.
6. In the Select Computer window, select the Local computer option and click Finish.
24
7. In the Add or Remove Snap-ins window, click OK.
8. In the Certificates (Local computer) tree-view, select Personal > Certificates.
9. Select EkranMasterCertificate and in its context menu select All Tasks > Export.
25
15. On the Security page, select the Password option and enter the password in the Password
and the Confirm password fields. Click Next.
NOTE: Make sure that you remember the password since you will need it when restoring
the certificate or transferring it to another server.
16. On the File to Export page, specify the location to store the certificate and the certificate
name manually or click Browse, and click Next.
17. On the Completing the Certificate Export Wizard page, click Finish.
NOTE: You will need the certificate for reinstalling the Server, moving it to another
computer, or creating the High Availability cluster.
26
Deleting Ekran Master Certificate
To delete Ekran Master Certificate, do the following:
1. On the Ekran Server computer, press Windows+R, type mmc in the Run text box and press
Enter.
2. In the opened User Account Control window, click Yes.
3. In the Console window, select File > Add/Remove Snap-in.
4. In the Add or Remove Snap-ins window, select Certificates and click Add.
5. In the Certificates Snap-in window, select the Computer account option and click Next.
6. In the Select Computer window, select the Local computer option and click Finish.
7. In the Add or Remove Snap-ins window, click OK.
8. In the Certificates (Local computer) tree-view, select Personal > Certificates.
9. Select EkranMasterCertificate and in its context menu select Delete.
10. Click Yes in the confirmation message.
27
Installing the Server in the Cloud
To install the server in the cloud, do the following:
1. In the cloud, install the Server in a usual way.
2. In the cloud management console, allow the Server executable to accept TCP connections
via ports 9447 (for the connection between the Server and the Clients), 22712, 22713,
and 22714 (for the connection between the Server and the Management Tool).
NOTE: It is recommended to install the Server and Management Tool on the same
computer.
3. In the Windows Firewall with Advanced Security window, right-click Inbound Rules
and select New rule.
28
4. The New Inbound Rule Wizard opens.
5. On the Rule Type page, select Program and click Next.
6. On the Program page, select This program path, then click Browse and navigate to
the Server executable. The default path is "C:\Program Files\Ekran System\Ekran
System\Server\EkranServer.exe ". Click Next.
7. On the Action page, select Allow the connection and then click Next.
29
8. On the Profile page, select the profile of the network used for connecting remote
computers and the Server. Click Next.
9. On the Name page, define the Name of the rule. Click Finish.
10. The rule is created for the Server application. By default, the rule allows any
connections via all ports.
11. To define the protocol and ports, double-click the created rule. The Ekran Properties
window opens.
30
In the Protocols and Ports tab, do the following:
In the Protocol Type list, select TCP.
In the Local port list, select Specific Ports. Type the following port numbers in
the box below:
o 9447 (for the connection between the Server and the Clients)
o 22713 and 22714 (for the connection between the Server and the
Management Tool)
o 22712 (for the connection between the Server and the Tray Notification
Application)
12. Click Apply to save changes. Click OK.
13. Close the Windows Firewall window.
31
Updating the Server
The updating of the Server is performed via the installation file of a newer version. During an
update you may select to update the existing database to a newer version or simply reinstall it.
NOTE: To change the type of a database, you need to reinstall the whole system.
6. On the Administrator password page, define the password for the administrator (the
default user of Ekran System with login admin and full permissions). Click Next.
7. The update process starts.
8. After the end of the update process, click Finish to exit the wizard.
9. If you are updating Server from version lower than 5.5, back up EkranMasterCertificate .
10. If you are updating Server from version 5.5 and higher, make sure that the master
certificate is correct. If necessary import it from the backed up copy.
32
Uninstalling the Server
The Server uninstallation is an irreversible operation, during which the database is removed
without any user confirmations.
NOTE: Before uninstalling the Server, make sure you have uninstalled all the Clients from the
remote computers. If you don't uninstall the Clients, they will remain installed on the remote
computers and collect the data locally. It will be impossible to remove them in a common
way.
To uninstall the Server from the local computer, do the following:
1. Run the EkranSystem_Server.exe installation file or click Uninstall/Change on the
Ekran System application in the Programs and Features window of the Windows
Control Panel.
2. The setup wizard opens.
3. Click Next on the Welcome page.
4. On the Already Installed page, select Uninstall and click Next.
33
6. If you want to delete the database, click Yes in the confirmation message. In other
case, click No and you will be able to use the saved database during the next
installation of the program.
34
Shared Folders on mapped and mounted disks cannot be used for storing binary data.
After you select to store binary data in the shared folder instead of MS SQL database, the
already existing screenshots will no longer be displayed (only metadata will be available for
them). The newly received screenshots will be displayed.
4. To access binary data in the shared folder on a different computer from your Server, it is
recommended to do the following:
Open Computer Management.
In the Computer Management window, open Services and Applications > Services.
In the Services pane, find the EkranServer service and select Properties in the context
menu.
In the EkranServer Properties window navigate to the Log On tab.
In the Log On tab, select the This account option, specify the credentials for the
EkranServer service to start under, and click Apply. Make sure the user with the specified
credentials has administrator permissions on your Server computer and full access to the
shared folder on the different computer.
Restart the service.
35
5. Start the EkranServer service to continue working with the program.
36
Validating Monitoring Data Using Hash Codes
To enable calculating of hash codes for monitoring data, do the following:
1. Stop the Server by clicking Stop in the context menu of the Server icon in the
notification area or find the EkranServer service in the Task Manager and click Stop.
2. Open the Windows Registry Editor.
3. In the Registry Editor window, select the
HKEY_LOCAL_MACHINE\SOFTWARE\EkranSystem key.
4. Select Edit > New > DWORD (32-bit) Value and define the following:
Value name: SignMonitoredData
Value data: 1
5. Start the EkranServer service to continue working with the program.
1. On the Ekran Server computer, press Windows+R, type mmc in the Run text box and
press Enter.
2. In the opened User Account Control window, click Yes.
3. In the Console window, select File > Add/Remove Snap-in.
4. In the Add or Remove Snap-ins window, select Certificates and click Add.
37
5. In the Certificates Snap-in window, select the Computer account option and click Next.
6. In the Select Computer window, select the Local computer: (the computer this console
is running on) option and click Finish.
7. In the Add or Remove Snap-ins window, click OK.
8. In the Certificates (Local computer) tree-view, find the Personal node.
9. In the context menu of the Personal node, select All Tasks > Import.
38
13. If required, on the Private key protection page, enter the password for the private key
and then click Next.
39
15. On the last page of the Certificate Import Wizard, click Finish, and then click OK in the
confirmation message.
16. Select Certificates (Local Computer) > Personal > Certificate and double-click the
imported certificate.
17. In the Certificate window, select Details > Thumbprint and then copy the Thumbprint
value.
40
Step 2. Enabling Monitoring Data Signing with Certificate
1. Stop the Server by clicking Stop in the context menu of the Server icon in the
notification area or find the EkranServer service in the Task Manager and click Stop.
2. Open the Windows Registry Editor.
3. In the Registry Editor window, select the
HKEY_LOCAL_MACHINE\SOFTWARE\EkranSystem key.
4. Select Edit > New > String Value > and add a new value:
Value name: SignMonitoredDataCert
Value data: <copied Thumbprint value of the imported certificate
(without spaces)>
5. Start the EkranServer service to continue working with the program.
41
Management Tool
About
The Management Tool is the component for managing the whole system and viewing
monitored data received from Clients. It can be installed on any computer, but a network
connection to the Server is required for the Management Tool to operate. There can be several
computers with the installed Management Tool in the system. The work with the Management
Tool is performed via your browser.
To turn on the Internet Information Service for Windows 8 and Windows 7, do the following:
1. Select Control Panel > Programs and Features (Program uninstallation).
42
2. Click the Turn Windows features on or off navigation link.
3. The Windows Features window opens.
4. In the features tree-view, select the Internet Information Services option.
5. Click OK.
43
3. The Add Roles Wizard opens.
4. On the Before You Begin page, click Next.
5. On the Server Roles page, select Web Server (IIS), click Next, and then go to the Role
Services page to start configuring Web Server (IIS).
44
To turn on the Internet Information Service for Windows Server 2012 using Server Manager,
do the following:
1. In the Start menu, select Server Manager.
2. In the navigation pane, select Dashboard, then click Manage > Add roles and features.
6. On the Server Selection page, select Select a server from the server pool, select your server
from the Server Pool list, and then click Next.
45
7. On the Server Roles page, select Web Server (IIS), click Next and then click Add Features to
start configuring Web Server (IIS).
46
Installing .NET Framework
Windows 10 and Windows Server 2016 usually have .NET Framework 4.6 installed.
If you are using Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Server
2008, or if there is no .NET Framework 4.5.2 on other Windows versions, you can download it
from the Microsoft official https://www.microsoft.com/en-us/download/details.aspx?id=42642
and run the installation file on your computer.
Alternatively, on Windows Server 2012, you can install .NET Framework 4.5.2 using Windows
PowerShell.
To install .NET Framework 4.5.2 and configure Internet Information Service (IIS) for Windows
Server 2012 using Windows PowerShell, do the following:
1. In the Start menu, select Windows PowerShell.
2. Enter the following command and click Enter:
Install-WindowsFeature - NET-Framework-Core, NET-Framework-45-ASPNET, Web-
Asp-Net45, Web-ISAPI-Ext, Web-ISAPI-Filter
47
Windows 8 Make sure that all the following options are selected in the Windows
Features window and then click OK:
.NET Framework 4.5 Advanced Services;
Windows 7 Make sure that all the following options are selected in the Windows
Features window and then click OK:
Internet Information Services > Web Management Tools > IIS
Management Console;
48
Internet Information Services > World Wide Web Services >
Application Development Features > ASP.NET;
Windows 1. In the Add Roles and Features Wizard window, on the Server
Server 2016 Roles page, make sure that the Web Server (IIS) option is selected
and then click Next.
2. On the Features page, make sure that the following option is
selected:
3. .NET Framework 4.6 Features > .NET Framework 4.6 and ASP.NET
4.6
4. Click Next.
5. On the Web Server Role IIS page, click Next.
6. On the Role Services page, select the ASP.NET 4.6 option (under
Application Development).
49
9. Click Next and then click Install.
10. After the end of installation, click Close.
Windows 1. In the Add Roles and Features Wizard window, on the Server
Server 2012 Roles page, make sure that the Web Server (IIS) option is selected
and then click Next.
3. Click Next.
4. On the Web Server Role IIS page, click Next.
5. On the Role Services page, select the ASP.NET 4.5 option (under
Application Development).
Windows 1. In the Add Roles Wizard window, on the Role Services page, make
Server 2008 sure that the following options are selected:
Common HTTP Features > Static Content;
50
Application Development > ASP.NET and WebSocket
Protocol.
2. Click Next and then click Add Required Role Services.
3. On the Role Services page, make sure that the following options
are selected:
Management Tools > IIS Management Console.
Using Certificates
Generating Self-Signed Certificate
To generate a self-signed certificate on the machine, on which you will install the
Management Tool, do the following:
1. Open the Internet Information Service Manager:
For Windows 8 or Windows 7: Open Computer > Manage > Services and
Applications > Internet Information Services (IIS) Manager.
For Windows Server 2012 or Windows Server 2008: Press Windows+R, enter
inetmgr in the Run window and then press Enter.
NOTE: Using the inetmgr command is a common way of opening the Internet Information
Service Manager for any version of the Windows operating system.
2. Click the main node in the Connections tree-view and then double-click the Server
Certificates item under the IIS category.
51
3. The Server Certificates pane opens.
4. On the Actions pane (to the right), click Create Self-Signed Certificate.
52
7. The certificate is created.
53
Exporting Self-Signed Certificate
To export self-signed certificate, do the following:
1. In the Internet Information Service Manager, on the Server Certificates pane, select the
generated certificate and click Export on the Actions pane or in the certificate right-click
menu.
2. In the Export Certificate window, define the location and password for the certificate. Click
OK.
3. The certificate is exported and can be added to the Trusted Root Certification Authorities.
54
5. In the Import Certificate window, click the Browse button to browse for the file of the
purchased certificate and enter its password in the Password field.
6. Click OK.
7. The certificate is imported and displayed on the Server Certificates pane of the Internet
Information Services (IIS) Manager.
To add the certificate to the Trusted Root Certification Authorities, do the following:
1. Press Windows+R, type mmc in the Run text box and press Enter.
2. In the opened User Account Control window, click Yes.
3. In the Console window, select File > Add/Remove Snap-in.
55
4. In the opened Add or Remove Snap-ins window, select Certificates > Add.
5. In the opened Certificates snap-in window, select Computer account and click Next.
6. In the opened Select Computer window, select Local computer: (the computer this console
is running on) and click Finish.
56
8. In the Console window, expand the Certificates (Local computer) node.
9. In the Certificates (Local computer) tree-view, find the Trusted Root Certification
Authorities node.
10. In the right-click menu of the Trusted Root Certification Authorities node, select All Tasks >
Import.
57
13. On the File to Import page, click Browse to find the certificate to be imported and then click
Next.
14. On the Private key protection page, enter the certificate password and then click Next.
58
15. On the Certificate Store page, click Next.
16. On the last page of the Certificate Import Wizard, click Finish.
17. In the confirmation message, click OK.
59
18. The certificate is imported and is displayed in the Console window in the Certificates node.
Please note that the Issued To field contains the name of the computer, on which the
Management Tool will be installed in the format that will be used when opening the
Management Tool.
60
Setting HTTPS Binding for a Default Web-Site
To set HTTPS binding for a default web-site, do the following:
1. Open the Internet Information Service Manager:
For Windows 8 or Windows 7: Open Computer > Manage > Services and
Applications > Internet Information Services (IIS) Manager.
For Windows Server 2012 or Windows Server 2008: Press Windows+R, enter
inetmgr in the Run window and then press Enter.
NOTE: Using the inetmgr command is a common way of opening the Internet
Information Service Manager for any version of the Windows operating system.
2. Expand the node with the name of the target computer in the central pane.
3. Expand the Sites node.
4. Select the Default Web Site.
NOTE: If there is no such site in the Internet Information Services (IIS) Manager of your
computer, you can select any other site (the name of the site does not matter).
7. If there is no binding of HTTPS type in the Site Bindings window, click Add.
8. The Edit Site Binding window opens.
61
9. In the Type box, select https.
62
In the URL address field enter the folder where the Management Tool will be
located within IIS. This URL will be used when opening the Management Tool.
5. On the Choose Install Location page, enter the destination folder in the corresponding
field or click Browse and in the Browse For Folder window, define the destination
folder. Click Install.
6. The process of installation starts. Its progress is displayed on the Installing page.
7. After the end of the installation process, click Close to exit the wizard.
8. The Management Tool is displayed as an application of a default web site or any other
site with https connection in the Internet Information Services (IIS) Manager.
63
9. Now you can open the Management Tool via your browser from the same computer
or a remote one.
To adjust Firewall on the computer where the Management Tool is installed, do the
following:
1. In the Control Panel, select System and Security > Windows Firewall.
2. In the Windows Firewall window, click Advanced settings.
3. In the Windows Firewall with Advanced Security window, right click Inbound Rules
and select New rule.
4. The New Inbound Rule Wizard opens.
5. On the Rule Type page, select Predefined and then select Secure World Wide Web
Services (HTTPS) in the list. Click Next.
64
6. On the Predefined Rules page, select the World Wide Web Services (HTTPS Traffic-In)
check box. Click Next.
65
7. On the Action page, select Allow the connection. Click Finish.
66
Uninstalling Management Tool
To uninstall the Management Tool, do the following:
1. Open the Programs and Features window of the Windows Control Panel.
2. In the Programs and Features window, find the Ekran System Management Tool
application.
3. In the right-click menu of the application, select Uninstall.
4. The setup wizard opens and starts the uninstallation process.
5. When the process is completed, click Close, to exit the setup wizard.
6. The Management Tool is uninstalled and removed from the Internet Information Service
(IIS).
Please note, the Management Tool may take a while to launch on first connection, since
IIS is not used constantly and its processes are stopped and restarted on the connection.
If you encounter any problems when opening the Management tool, see the
Troubleshooting chapter.
67
Licensing
General Licensing Information
To start receiving information from the Clients, you have to assign licenses to them. Four
types of licenses are available:
Windows desktop
OS, Windows
Workstation
desktop in - 1
Client
Amazon or Azure
Cloud, macOS
Infrastructure
- 2
Server Client
installed
Remote Desktop
Services/Terminal Services
or
Citrix Server
Windows Server
Terminal or
Published App Server unlimited
Server Client
or
deployed on
Microsoft Azure
or
Amazon Web Services
NOTE: Licenses of the workstation type cannot be assigned to a computer with Server OS.
Each Client can have only one license assigned. During the first connection to the Server, the
license corresponding to the Client computer operating system is automatically assigned to a
Client. If the license has not been automatically assigned, then you will have to assign the
license to the Client manually.
68
1 Terminal Server Client license for 30 days. The trial serial key will be sent to the email address
you specify in the request form.
To use the system permanently and with a greater number of licenses, you have to license it
with purchased serial keys on a computer with the installed Server.
NOTE: After activation of any serial key, the embedded trial key expires.
Each permanent, trial, and update and support serial key contains the following data:
Update & support period
Licenses for the Clients
The enterprise serial key does not contain any Client licenses and is active during the unlimited
period of time. This key grants you an access to such valuable features of the Ekran System as
Database Archiving, Advanced SIEM Integration, One-time Password, and High-Availability,
Multi-Tenant Mode, Password Management, IP Filtering, Isolating database from Clients, and
Health Monitoring.
Once you have purchased serial keys, you can either activate serial keys online or add activated
serial keys if you have no Internet connection on a computer with the installed Server. Contact
your vendor for information on purchasing serial keys.
You need to belong to the Administrators user group of the built-in default tenant to activate
serial keys.
Please note, after the activation, serial keys are bound to a specific computer and cannot be
used on another computer.
69
expires, you can still assign licenses to Clients, but you will be unable to update the System to
versions released after the update & support period expiration date.
The update & support period end date is defined during the serial key activation (either via the
Management Tool or on the vendor’s site). It is calculated using a serial key with the longest
update & support period period.
Example: If you activate two keys, one with a 30 days update & support period period and one
with a 12 months update & support period period, simultaneously, the update & support
period end date will be set to 12 months from the activation date.
When a new serial key is being activated, the update & support period period is prolonged
accordingly. Please note, if the current update & support period period is longer than the one
of a key being activated, current update & support period period does not change. For
example, if you activate a key with 12 months update & support period period after a key with
30 days update & support period period, the update & support period end date will be set to
12 months since the activation date. But if you activate a key with 30 days update & support
period period after a key with 12 months update & support period period, the update &
support period end date will not change.
If your update & support period expires, you can purchase a special serial key, which does not
contain any licenses, but extends your update & support period period, or you can activate any
other serial key.
To view the license state, open the Management Tool and click Serial Key Management
navigation link on the left.
70
o State: activated/deactivated/expired
o Details: expiration/deactivation date, type and number of licenses
6. The activated keys will appear on the Serial Key Management page.
7. The number of available licenses and the update & support period end date change.
72
to avoid issues with the serial keys activation, you need to define the Proxy Server parameters
in the Ekran Server configuration file.
To define the Proxy Server parameters in the Ekran Server configuration file, do the
following:
1. On the machine with the installed Ekran Server, navigate to the folder with the
EkranServer.exe.conf file. By default, C:\Program Files\Ekran System\Ekran System\Server.
2. Open the EkranServer.exe.conf file.
3. In the EkranServer.exe.conf file, in the BasicHttpBinding group, define the Proxy Server
IP address and port, and then set the useDefaultWebProxy value to false.
Example:
// <basicHttpBinding>
<binding name="GetLicenseBinding" proxyAddress="http://10.0.0.000:10"
useDefaultWebProxy="false" />
<binding name="GUIDDeactivationBinding"
proxyAddress="http://10.0.0.000:10" useDefaultWebProxy="false" />
<binding name="GetLicensesByHwidBinding"
proxyAddress="http://10.0.0.000:10" useDefaultWebProxy="false" />
<binding name="GetTrialBinding" proxyAddress="http://10.0.0.000:10"
useDefaultWebProxy="false" />
<binding name="GetLicenseByGuidBinding"
proxyAddress="http://10.0.0.000:10" useDefaultWebProxy="false" />
<binding name="GetActualVersionBinding"
proxyAddress="http://10.0.0.000:10" useDefaultWebProxy="false" />
</basicHttpBinding>
73
Client License Management
The Client license management is performed in the Management Tool by the user with the
administrative Client installation and management and License management permissions.
You can assign a license to a Client or unassign it manually any time. The license can be
assigned to an offline Client and it will be applied after the Client is online. If the Client is
uninstalled, its license becomes free and can be assigned to another Client.
NOTE: When a trial serial key expires, the corresponding number of licenses is automatically
unassigned from Clients.
Information about the number of used and free licenses of each type is displayed on the
License Management page in the Management Tool.
74
NOTE: To change the Client license type, you do not need to unassign the current license.
This will be done automatically.
75
Windows Clients
About
Windows Client is a program that can be installed on the target computers to monitor the
activity of their users. The monitored data is sent by the Windows Client to the Server and can
be viewed in the Management Tool.
Depending upon their permissions, a user can install/uninstall Clients remotely, manage their
configuration, and manage Client groups.
77
You need to know the domain administrator or local administrator account credentials
for the remote computer.
The Server and the Remote Procedure Call (RPC) system services have to be running on
the remote computer.
Windows Vista and Windows XP Firewall has to be properly set up on the remote
computer during the Clients remote installation.
In Windows 8, Windows 7, Windows Server 2012 and Windows Server 2008 Firewall,
inbound connections have to be allowed in the Remote Service Management (RPC) rule
for the remote computers and the File and Printer Sharing option has to be enabled (in
this case it is not necessary to disable Windows Firewall).
Due to the new SHA-256 code signing, on Windows 7 SP1 and Windows Server 2008 R2
SP1, the Microsoft Security Advisory update 3033929 needs to be installed:
https://technet.microsoft.com/en-us/library/security/3033929.aspx.
In Windows Firewall on the Server side, allow the Server executable to accept TCP connections
via ports 9447 (for the connection between the Server and the Clients).
NOTE: These rules will be added to Windows Firewall automatically, if Windows Firewall is
enabled during the Server installation.
Make sure the conditions mentioned above are met to avoid possible problems with Client
remote installation.
78
Clear the Use simple file sharing check box.
4. Click Apply and OK to close the window.
79
Clear the Use Sharing Wizard check box.
3. Click Apply and OK to close the window.
80
4. If one or both services are not running, start them manually. To start the service,
right-click it and select Start from the context menu. The selected service is started.
To set up Windows Vista, Windows XP, and Windows Server 2003 Firewall, do the following:
1. Select Start > Control Panel > Windows Firewall.
81
2. In the Windows Firewall window, select the Exceptions tab.
3. On the Exceptions tab, select the File and Printer Sharing check box.
4. Click Ok.
82
Setting up Firewall for Windows 10, Windows 8.1, Windows 8,
Windows 7, Windows Server 2012, Windows Server 2008
It is not necessary to disable the Firewall in Windows 8.1, Windows 8, Windows 7, Windows
Server 2012, and Windows Server 2008. For successful remote installation of the Clients, you
have to allow inbound connections in the Remote Service Management (RPC) rule for the
remote computers and enable the File and Printer Sharing option.
To enable inbound connections for the Remote Management Service (RPC), do the following:
1. Select Control Panel > System and Security > Windows Firewall.
2. In the Windows Firewall window, click Advanced settings.
3. In the Windows Firewall with Advanced Security window, click Inbound Rules and
then double-click the Remote Service Management (RPC) rule in the rules list.
83
6. In the Advanced tab, under Profiles, select the profile of the network used for
connecting remote computers and the Server.
7. Click Apply and then OK to save the settings and close the Properties window.
8. Close the Windows Firewall window.
84
To enable the File and Printer Sharing option, do the following:
1. Select Control Panel > System and Security > Windows Firewall.
2. In the Windows Firewall window, click Allow an app or feature through Windows Firewall.
3. In the opened Allowed apps window, click Change settings.
4. Select the File and Printer Sharing option and then click OK.
85
Installing Windows Clients Remotely via the Management
Tool
About
You can install the Windows Clients remotely via the Management Tool. This way of installation
is very convenient if all computers in your network have the same domain administrator
credentials.
Remote Windows Client Installation is performed by a user who has the Client installation and
management permission in two steps:
1. Selecting computers on which Clients will be installed.
2. Defining installation parameters and installing the Clients.
Selecting Computers
To select the computers for Client installation, do the following:
1. Log in to the Management Tool as a user with the Client installation and management
permission.
2. Click the Client Management navigation link to the left.
3. On the Clients page, click Install Clients.
4. The Computers without Clients page opens. On this page, you can see the computers, for
which the previous installations failed.
5. Select how you would like to search for computers where the Windows Clients will be
installed:
To select computers from the list of all computers in your network, click Deploy via
network scan.
To select computers by IP range (IPv4 or IPv6 addresses), click Deploy via IP range.
To select computers by their names, click Deploy on specific computers.
6. In the Choose search results window:
Click Start new search to look for computers with defined parameters.
86
Click Previous search results to choose the computers found in the previous search.
If you have not performed any searches yet, this button will be absent.
7. If you have selected the Deploy via IP range option, the Computers Scan page opens. In the
From Address and To Address boxes, enter the IP range (either IPv4 or IPv6), for which the
network should be scanned. To find only one computer, enter the same IP address in both
boxes. Click Scan.
8. If you have selected the Deploy on specific computers option, the Adding Computers page
opens. Enter the names of computers on which Windows Clients must be installed in the
box Name and click Scan. Use semicolon to separate computer names.
Please note that you should enter the full name of the computer.
9. The scanning process starts. The list of found computers will be updated automatically. If it
is not updated, click Refresh. To stop the scanning process, click Stop.
10. When the scanning process finishes, select check boxes next to the computers that you
want to install the Clients on. Click Next.
11. The selected computers are added to the list on the Computers without Clients page.
87
12. If you want to remove some computers from this list, click Remove from list next to the
selected computer.
88
4. The installation process starts. The progress of installation will be updated automatically on
the Client installation page. If it is not updated, click Refresh.
NOTE: If the connection with the Server fails, the Client will be not installed.
5. After the end of the installation, the installed Clients will appear on the Clients page in All
Clients group. If the installation of some Clients fails, these computers will remain in the
Computers without Clients list and you can click Retry to start the installation again.
3. Once the .ini file is chosen, click Next and continue the installation the same way as when
installing the Clients remotely in a common way.
89
NOTE: Due to the new SHA-256 code signing, on Windows 7 SP1 and Windows Server 2008 R2
SP1, the Microsoft Security Advisory update 3033929 needs to be installed:
https://technet.microsoft.com/en-us/library/security/3033929.aspx.
Server name/IP
RemotePort The Ekran Server port via which the Clients 9447
connect to the Server. By default, it is set to
9447.
90
Parameter Description Default Value
Screenshot settings
Monitoring parameters
91
Parameter Description Default Value
EnableSwiftUsernam
Logging of user names used to log in to the SWIFT Disabled
eMonitoring network. If the value is 1, the option is enabled, if
the value is 0 - disabled.
NOTE: This parameter works only if
EnableScreenshotCreation=1.
92
Parameter Description Default Value
Log files
URL Monitoring
93
Parameter Description Default Value
Application Filtering
User Filtering
Additional options
94
Parameter Description Default Value
OfflineClientDetecti The notification about the Clients that are offline Disabled
on for more than specified time period. If the value
is 1, the offline Client detection is enabled, if the
value is 0 – disabled.
OfflineClientDetecti The time period after which the Client will be 01d00h00m
onInterval detected as “lost”.
MonitoringDays The days of the week during which the Client will Mon, Tue,
or will not record users' activity. The days of the Wed, Thu, Fri
week are combined by OR logic.
95
Parameter Description Default Value
MonitoringHours The hours during which the Client will or will not 8:00 – 18:00
record users' activity.
IP Filtering
Authentication Options
96
Parameter Description Default Value
Advanced Options
98
In the Command Prompt (cmd.exe) started under administrator, enter
EkranSystemClient.exe /ServerName=<Server Name>.
NOTE. If there is no connection with the server, installation will failed and error
message will be displayed.
2. After the package is deployed, the installed Client appears in the list on the Client
Management page in the Management Tool.
99
4. Run the Command Prompt (cmd.exe) as administrator.
5. Navigate to the folder with the the installation file and PsExec.exe by entering the following
command:
cd path/to/folder
6. Enter the following command to the command line:
psexec\\<target PC IP>-u<user name>-p< password>-c EkranSystemClient.exe
/servername=<server name/IP> and press Enter
Each new Client with a new AgentGUID will be displayed as a separate instance in the
Management Tool. To avoid displaying multiple Clients, you can run the script below to
use the virtual machine name as AgentGUID. The script must be run on each system start.
100
taskkill /f /im ekran*
101
1. Start your virtual machine image.
2. Configure the system and install the necessary software.
3. Install Ekran Client (via remote installation or locally) with the Protected Mode option
disabled.
4. Open the Windows Registry Editor.
5. In the Registry Editor window, select the following key:
HKEY_LOCAL_MACHINE\SOFTWARE\EkranSystem\Client
6. Select the AgentGUID value and click Delete in the context menu.
7. In the opened confirmation message, click Yes.
8. Copy uninstall_client.cmd to the target folder on your virtual machine.
9. Run the Command Prompt (cmd.exe) as administrator.
10. Enter the gpedit command.
11. In the Local Group Policy Editor window, select Computer Configuration -> Windows
Settings -> Scripts (Startup/Shutdown) -> Shutdown
12. In the Shutdown Properties window, click Add and select the uninstall_client.cmd file.
13. Click OK.
14. Create the master snapshot (gold image).
15. From now on, whenever you start the virtual machine using this image, the Client is
going to connect to the Server as a new Client and get a license assigned to it. Whenever
the virtual machine is shutdown, the license is going to be unassigned from the Client.
NOTE: If you need the license to be unassigned on Logoff, you have to edit the Logoff script in
a similar way in the Local Group Policy Editor (User Configuration -> Windows Settings ->
Scripts (Logon/Logoff) -> Logoff -> Properties).
The automatic Client update is performed when a Windows Client connects to the Server of a
newer version. It is recommended to use the automatic Client update.
If you want to control the update of target Client machines yourself, you can disable the
automatic update on the required Clients and update them via the Management Tool.
After the Windows Client is updated, you will still be able to access the monitored data
received before its update.
NOTE: Windows Clients of very old versions might not be able to update. In this case, you
need to re-install the Clients.
102
Windows Client Status after Server Update
If the Update Client automatically option is enabled for the Windows Client, it is updated
automatically when it connects to the Server of a newer version.
If the Update Client automatically option is disabled for the Windows Client and it requires
manual update, it is displayed with the icon in the grid on the Clients page. Such Clients
store the monitoring data locally. They restart sending monitoring data to the Server after
update.
103
Reconnecting Windows Clients to Another Server
If you want to reconnect the Windows Clients to another Server, start the remote installation
from that Server. The Clients will be reconnected.
Please note that this way of reconnection can be used only for the Clients that work in the non-
protected mode. If your Clients work in the protected mode, first disable the protected mode
and then reconnect the Clients.
104
Uninstalling Windows Clients Remotely
To uninstall a Windows Client, do the following:
1. Log in to the Management Tool as a user that has the Client uninstallation permission.
2. Click the Client Management navigation link to the left.
3. On the Clients page, select the Client you want to uninstall and click Edit Client.
4. On the Editing Client page on the Properties tab, click Uninstall Client.
NOTE: This option is not displayed if the Client is already uninstalled or you don’t
have the Client uninstallation permission for it.
5. In the confirmation message, click Uninstall.
6. The Client is uninstalled.
105
Viewing Windows Clients
Windows Clients are displayed in groups on the Client Management page. If the user has an
administrative Client installation and management permission, he/she will see all Clients. In
other case, the user will see only those Clients for which they have at least one Client
permission.
The Client list contains the following information:
Client name
Status
Type
Domain
IPv4
IPv6
Description
Please note, if there are several network cards on the Client computer, only those IPv4 and
IPv6 addresses used by Windows Clients will be displayed in the Management Tool.
106
macOS Clients
About
macOS Client is a program that can be installed on the target computers to monitor the activity
of their users. The monitored data is sent to the Server and can be viewed via the Session
Viewer in the Management Tool.
107
Installing macOS Client
About
You can install the macOS Clients locally using the Client installation file generated in the
Management Tool.
To install the macOS Client on the target computer with a macOS operating system from the
command line:
1. Make sure that there is only one user logged in to the computer.
2. Copy the installation package to any folder.
3. Run the Terminal.
4. Navigate to the folder with the installation package by entering the following command:
cd path/to/folder
5. Unpack the installation package using the following command:
tar xvfz <installation package name>
6. Navigate to the unpacked EkranClient folder using the following command:
cd EkranClient
The EkranClient folder contains the install.sh script used to install the Client.
7. Run the macOS Client installation script specifying the Server name or Server IP address
and the port used for connection to the Server (9447 is recommended):
./install.sh <server_name/IP> <server_port>.
8. After the end of the installation, macOS Client will appear in the list on the Clients page in
the Management Tool.
108
Uninstalling macOS Clients
About
macOS Clients can be uninstalled locally or remotely.
After uninstallation, the Client stops sending its data to the Server, but its data is not
deleted from the Server and the Client is displayed in the Management Tool. The Client
status in the Management Tool becomes offline after uninstallation.
To delete the Client from the Server (with all its captured data) and from the Management
Tool, follow the steps described in the Deleting the Client section.
109
Uninstalling macOS Clients Locally
To uninstall the macOS Client from the command line, do the following:
1. Run the Terminal.
2. Do one of the following:
Navigate to the folder with the macOS Client by entering the command:
sudo cd /Library/Application\ Support/Ekran/EkranAgent.
The EkranAgent folder contains the uninstall.sh script used to uninstall the Client.
Run the uninstallation script by entering the following command: sudo ./uninstall.sh
and press Enter.
Or
Run the uninstallation script by entering the following command: sudo
/Library/Application\ Support/Ekran/EkranAgent/uninstall.sh and press Enter.
3. Enter the password of the superuser.
4. macOS Client is successfully uninstalled.
110
Linux Clients
About
The Linux Client is a program that can be installed on the target computers to monitor the
activity of their users in the terminal. The monitored data is sent by the Linux Client to the
Server and can be viewed via the Session Viewer in the Management Tool.
Optionally, during the Linux Client installation, you can enable monitoring of graphical interface
for X Window System. It allows monitoring the user sessions started locally via the graphical
interface.
NOTE: Monitoring of graphical interface for X Window System is a Beta version.
111
Installing Linux Client
About
You can install the Linux Clients locally from the command line using the
EkranSystemLinuxClient.tar.gz package, respectively:
EkranSystemLinuxClientx64.tar.gz for the 64-bit system
EkranSystemLinuxClientx86.tar.gz for the 32-bit system
To install the Linux Client on the target computer with a Linux operating system from the
command line:
1. Copy the installation package to any folder. Make sure you use the correct installation
package (x64 or x86).
112
2. Run the command-line terminal.
3. Navigate to the folder with the installation package by entering the following command:
$ cd path/to/folder
4. Unpack the installation package using the following command:
$ tar xvfz <installation package name>
Examples:
$ sudo ./install.sh 10.100.4.182 9447 – The Client connects to the Server with IP
10.100.4.182 through the port 9447. The monitoring of graphical interface for X
Window System is not enabled.
$ sudo ./install.sh Server1 9447 -withX11 -tenantKey 90807A10-DF80-45EA-A7DE-
A550B55F548A - The Client connects to the Server with the name Server1 through
113
the port 9447. The monitoring of graphical interface for X Window System is
enabled. The Client belongs to the tenant with the specified tenant key.
7. After the Client is installed, it starts monitoring a new session with the next user login.
8. The installed Linux Client appears in the list on the Client Management page in the
Management Tool.
114
6. The Client will be updated automatically when it connects to the Server of a newer
version.
$ cd /opt/.Ekran
3. The .Ekran folder contains the uninstall.sh script used to uninstall the Client.
4. Run the uninstallation script by entering the following command: $ sudo ./uninstall.sh
and press Enter.
5. Enter the password of the superuser.
6. Linux Client is successfully uninstalled.
115
The Client list contains the following information:
Client name
Status
Type
IPv4
IPv6
Description
The Domain column is empty for Linux Clients.
Please note, if there are several network cards on the Client computer, only the IPv4 and IPv6
addresses used by Linux Clients will be displayed in the Management Tool.
You can filter Linux Clients in the following ways:
To sort Clients by the type of operating system, click the Type column header.
To find Linux Clients only, select Hide Windows Clients and Hide macOS Clients and
click Apply Filters.
To find Clients by their host name or description, enter the name/description or a part
of it in the Contains box and click Apply Filters.
To hide offline/online/uninstalled/licensed Clients, select the corresponding option in
the Filtering pane and click Apply Filters.
116
Tray Notifications Application
About
The Ekran System Tray Notifications is a component to the Ekran System application that allows
you to receive notifications on alert events on Clients. Alerts are instances that notify the
investigator of a specific activity (potentially harmful/forbidden actions) on the target
computers with operating system on which Clients are installed and allow the investigator to
respond to such activity quickly without performing searches.
The application is completely independent and can be used for receiving alert notifications on
any computer.
117
Uninstalling the Tray Notifications Application
To uninstall the Tray Notifications application, do the following:
1. Run the TrayNotifications_<version>.msi installation file.
2. The setup wizard opens.
3. Click Next on the Welcome page.
4. On the Change, repair, or remove installation page, select Remove.
118
Troubleshooting
Quick Access to Log Files
Log files contain information that might be useful for administrator for detecting problems in
the system if any.
You can either analyse the log files yourself to get more information on what is happening in
your system or send them to the Support team to help them in detecting the source of
problems in your system.
To download the Management Tool log file, click the Health Monitoring navigation link to the
left, click next to the System state tab and select Download MT log file in the menu. In the
Save As window, browse to the location, where the log file should be saved, and click Save. The
log file will be downloaded to your computer.
To download the Server log file, click the Health Monitoring navigation link to the left, click
next to the System state tab and select Download Server log file. In the Save As window,
browse to the location, where the log file should be saved, and click Save. The log file will be
downloaded to your computer.
Please note that every time the Server restarts, a new log file is created. The latter log file can
be downloaded via Management Tool, other log files can be viewed in C:\Program Files\Ekran
System\Ekran System\ServerLogs.
To download the Client log file, click the Client Management navigation link to the left, and
then click the Download Logs link for the required online Client. In the Save As window, browse
to the location, where the log file should be saved, and click Save. The Client log file will be
downloaded to your computer.
NOTE: The log files can be downloaded only for the online Clients.
To download the Client log files for the Client Group, click the Client Management navigation
link to the left, and then click the Download All Logs link for the required Client Group. In the
Save As window, browse to the location, where the log files should be saved, and click Save.
The Client log files will be downloaded to your computer.
Database/Server
Database/Server Related Issues
Issue Cause/Solution
I cannot start the Server from the To start the Server, the Server tray service must be
Server tray. started under the administrator account.
There are too many records in the Use the automatic or manual database
database. cleanup feature to remove the old records
from the database.
119
Issue Cause/Solution
I have defined a new database, what The old database remains in place and is not
happened to the old one? changed.
I need to create a non-default SQL Make sure you have granted the dbcreator
database user whose account will be and public role to the SQL Server user whose
used for running Ekran System Server. account will be used for running CyFIR
Server. The User must change password at
next login option must be cleared.
I need to transfer the data from an old Unfortunately, the data cannot be
database to a new one/I want to transferred from one database to another.
change the type of the database
without losing data.
I have transferred the SQL database to Unfortunately, you can’t relocate the SQL
another computer. database to another computer. Though you can
move it to another location on the same PC with
SQL means.
I have changed the location of the To redefine the location of the Firebird
Firebird database. database, move it to another location and
change the corresponding values in the
Windows Registry Editor. See Moving the
Server Database chapter in the user manual
for more details.
I have installed a new version of the If you have updated the Server, your old
Server and I want to use the old database will remain. If you have reinstalled
database. the Server, you need to use a new database.
I have used the database cleanup The cleanup feature only removes data from
feature, but the size of the database the database, but doesn’t change the size
didn’t change. reserved by it. To reduce the size of the
database, click Shrink database on the
Database Management tab on the
Configuration page of the Management
Tool.
I cannot shrink the database: the Make sure you use the MS SQL Server
Shrink database button is absent in the database.
Management Tool on the Database The shrinking cannot be performed if
Options tab. the cleanup procedure is in progress.
120
Issue Cause/Solution
My anti-virus blocks the Server Due to the uninstaller specifics some anti-viruses
uninstallation/update. might detect it as a false positive during virus scan.
In this case, it is recommended to disable your
anti-virus during Server uninstallation/update.
Message Cause/Solution
If you get the following message in the The Server has lost the connection to the
Management Tool: "Connection with MS SQL Server. Please make sure that the
MS SQL database is lost. Please check MS SQL Server is running and it is online and
that the database is accessible and try accessible. To check that the MS SQL Server
again." computer is accessible, enter the following
command in the Windows command line:
ping <name of the MS SQL Server computer>
The connection to the MS SQL Server is
blocked by the Firewall. Try disabling the
Firewall on the MS SQL Server side.
If you get the following message when You can restart the Server service only under
trying to restart the Server service: the administrator account.
“Not enough permissions to restart
the Server.”
121
Message Cause/Solution
If you get the following message from The Server has lost the connection to the
the Server tray service: "The Server database. Please make sure that the
connection with the database has computer on which the database is installed
been lost. Click to view logs." is online and accessible. To check that the
computer is accessible, enter the following
command in the Windows command line:
ping <name of the computer with installed
database>
If the problem comes up again, please, send
us logs (the Server Service file), which you
can find in the Server sub-folder of the Ekran
System installation folder.
122
Message Cause/Solution
find in the Server sub-folder of the Ekran
System installation folder.
Management Tool
Management Tool Related Issues
Issue Cause/Solution
HTTP 500 Internal Server error is For Windows 7, follow these instructions:
displayed when I try to connect to the 1. Make sure that all the following check boxes
Management Tool. are selected in the Windows Features window:
Net Framework 3.5> Windows
Communication Foundation HTTP Activation
and Windows Communication Foundation
non-HTTP Activation.
2. Run the Command Prompt (cmd.exe) as
administrator:
Enter cd
%windir%\Microsoft.NET\Framework\v4.0.xxxx
x\aspnet_regiis.exe –iru (for 32 bit machine) or
%windir%\Microsoft.NET\Framework64\v4.0.x
xxxx\aspnet_regiis.exe –iru (for 64 bit
machine).
Example:
C:\Windows\Microsoft.NET\Framework64\v4.
0.30319\aspnet_regiis.exe –iru
3. Press Enter.
For Windows 10, 8.0 or 8.1, make sure that all the
following options are selected in the Windows
Features window: Net Framework 3.5> Windows
Communication Foundation HTTP Activation and
Windows Communication Foundation non-HTTP
Activation.
The license management function is Make sure you have the administrative Client
unavailable and I cannot assign licenses installation and management and License
to Clients. management permissions. In the Single-tenant
mode, if you have this permission, but the license
management function is still unavailable, then your
copy of the program is not licensed. Please purchase
serial keys and activate them online or activate
them on your vendor’s license site and add them
123
Issue Cause/Solution
offline. In the Multi-tenant mode, if you are a user of
a not default tenant, contact your technician to
make sure you have the granted licenses.
I have no Internet connection on the You can activate the serial on the license site of your
computer with the installed Server and vendor and then add activated keys on the
cannot activate serial keys. computer with the installed Server.
I have reinstalled/updated the Server If you activated serial keys online, after you
and now there are no activated serial reinstall or update the Server, activated serial
keys in it. keys will be automatically synchronized. For this
purpose, you need to have an active Internet
connection during the first start of the Server.
If you used an offline activation (added activated
serial keys), you need to add them in the
Management Tool again.
The list of the domain computers is This problem can be caused by network or Windows
empty during the Client installation. issues (e.g. your computer cannot connect to the
local network). If there are no network problems, try
searching for computers via the Add computers by
IP option. To install Clients in such a way, on the
Computers without Clients page click Add
computers by IP.
The list of the domain computers is Ekran System obtains the list of domain computers
not complete during the Client using standard Windows methods, which do not
installation. always provide the full list of computers.
The target computer is out of the If DNS settings of your computer network allow, you
domain. can:
Search for computers using the Add computers by
IP option. To install Clients in such a way, on the
Computers without Clients page, click Add
computers by IP.
Create an installation package and install a Client
locally on the target computer. To generate an
installation package, on the Computers without
Clients page, click Download installation file and
then select the type of the installation file you
want to download. When the installation file is
downloaded to your computer, you can start the
installation process.
I have assigned a Terminal Server Any license can be unassigned from a Client
Client license instead of a Workstation anytime.
124
Issue Cause/Solution
Client license to the Client or I have
assigned a license to the wrong Client.
There are some Clients that I did not These may be old Clients that were installed earlier.
install. You can uninstall them remotely via the
Management Tool or locally on the Client computer.
I do not receive email notifications, Make sure you do not use Microsoft Exchange
although the parameters are correct. Server 2010, which is not supported.
Some of the Management Tool Make sure that you have the corresponding
functions are unavailable. permissions for these functions.
The Management Tool page is Try clearing the browser cache and cookies and sign
displayed incorrectly. in again.
Some of the navigation links are not Try clearing the browser cache and cookies and sign
displayed on the Management Tool in again.
page.
I do not want to provide the user with By defining the Client permissions for the user in the
access to all Clients. Management Tool, you can define which Clients the
user will have the access to.
I forgot the password of the internal Contact the administrator and ask him to change the
user. password.
I forgot the password of the tenant If the tenant admin is registered via email, please
admin. contact your technician and ask to resend an email
with a new password.
If the tenant admin is a domain user, contact your
system administrator.
The user is able to perform actions that Check the groups which the user belongs to. He/she
are supposed to be prohibited for might have inherited some new permissions from
him/her (e.g. the user sees the Clients these groups.
that he/she doesn’t have a permission
for).
Message Cause/Solution
125
If you get the following message when The program encountered an unexpected error
trying to connect to the Management while trying to perform an action.
Tool: “Server is unavailable. Please Please refresh the Management Tool.
contact administrator.”
Please make sure that the Server is
running.
Please restart the Server and try again.
If the problem comes up again, please contact the
support.
If you get the following message when Please make sure that your login and the
trying to connect to the Management password are correct. If you are logging in as a
Tool: “Wrong password or Windows user, don’t forget to write <domain
username.” name>\<login>.
126
Windows Client
Checking that the Client Is Installed
If the Client is successfully installed, it will appear on the Clients page of the Management Tool
in the Data View pane.
If there is no Client in the Management Tool, you have to check whether the Client has been
installed.
You can check if the Client is installed on the investigated computer in one of the following
ways:
The EkranService.exe process is running.
The EkranClient and EkranController services are started.
127
The HKEY_LOCAL_MACHINE\SOFTWARE\EkranSystem\Client key has the following
values:
128
Clients Installation/Uninstallation Issues and Error Messages
The common reasons of issues with remote installation or uninstallation of Clients are the
inadequate network configuration or system settings. If you are sure that a user has
administrative rights on the Client computer, please check whether all of the conditions for
successful installation are met.
How to Check:
To check the administrative shares availability, do the following:
1. Open Windows Explorer.
2. In the address bar type \\<target_computer_IP/Name>\admin$ and press Enter.
129
3. When the Enter Network Password window opens, enter administrator credentials
and click OK.
4. If the login credentials are accepted, the system folder opens (by default,
C:\Windows).
If you get a login error after performing step 3, try the following:
Make sure that the credentials you enter are correct. You have to enter the credentials
of a domain administrator or a local administrator account on the remote computer.
Verify that the account password is not empty. Accounts with empty passwords cannot
be used for remote connection.
Try typing the username as <domain_name>\<username> if the remote computer is in
a domain, or <computer_name>\<username> if the PC belongs to a workgroup.
130
How to Fix:
To enable access to administrative shares, you need to enable the Local Account Token
Filter Policy.
NOTE: This is a known Windows issue that might block remote application installation.
If the LocalAccountTokenFilterPolicy registry value does not exist, follow these steps:
1. In the Windows Registry Editor in the Edit menu, click New, and then click DWORD Value.
2. Type LocalAccountTokenFilterPolicy and then press ENTER.
3. In the Value data box, type 1, and then click OK.
4. Close the Windows Registry Editor.
Issue: DNS Service is Unavailable
DNS service may be unavailable in your network. Try using the remote computer's IP address if
you cannot access it by the name.
How to check:
To check the DNS Service availability, please execute the following command in the Command
line (cmd.exe): ping <Computer name>.
If the command doesn’t respond, you have to enable the DNS Service.
How to fix:
To enable the DNS Service, please follow the instructions of the Windows Troubleshooting. In
the Windows Server 2003, you can use the netdiag.exe tool.
131
How to check:
By default, UAC is enabled in Windows 8/7/Vista.
How to fix:
To disable UAC, do the following:
1. Open the Windows Registry Editor.
2. Select the following key:
HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\Policies\System.
3. Double-click the EnableLUA value, or select it and click Modify in the right-click menu.
4. In the opened window, in the Value data filed, enter 0 and click OK.
5. Close the Windows Registry Editor window and then reboot the Client computer.
How to Fix:
To resolve errors in Active Directory, do the following:
1. Open the Active Directory Users > Computer Tools.
2. Open the System Container.
3. If there is no TDO object (trusted domain object) in the System container, please reset
the trust between parent and child relationships between domain controllers of
different domains with netdom.
How to Fix:
To resolve issues with SPN, do one of the following:
Login with domain admin of the child domain.
Wait for replication to complete and use the root admin account.
132
Issue: Two Computers Have the Same Computer Name
The computer in the child domain has the same name as the computer in the parent domain.
How to Fix:
To resolve this issue, rename the computer in the parent domain which has the same
name as the computer in the child domain.
If you get a message at the end of the remote Client installation: “The network name
cannot be found”, it can be caused by the following reasons:
There is no access to the remote computer.
There is no access to Network Shares.
Issue: There is No Access to the Remote Computer
How to Check:
Please check that you have access to the remote computer. To do this, enter the
following command in the Windows command line: ping <name of the remote computer>
If you do not receive any response, the access might be blocked by the remote computer
Firewall.
How to Fix:
Try enabling the Local Account Token Filter Policy on the target computer.
If you get a message at the end of the remote Client installation: “Client machine must be
rebooted before agent installation”, please, reboot the computer because if the Client has
been recently uninstalled, the Client computer must be rebooted first.
If you get a message after clicking Uninstall Ekran System Client: “The host is unavailable now
or turned off. Try again later.”, this means that the Client may be offline or may not be able to
connect to the Server. Please do one of the following:
Wait until the Client appears online.
If the Client does not appear online, uninstall it locally on the Client computer via the
Windows command line by executing the following command: UninstallClient.exe
/key=<uninstallation key>
By default, the UninstallClient.exe file is located here: C:\Program Files\Ekran System\Ekran
System\.
133
Linux Client
Checking the State of the Linux Client
If the Linux Client is successfully installed, it will appear on the Clients page of the Management
Tool in the Data View pane.
If there is no Linux Client in the Management Tool, you have to check whether the Client has
been installed.
To check the status of the Linux Client, run the command-line terminal and enter the following
command:
$ service Ekran status
134