Client setup
Clients should be installed on end-user workstations where the user input devices, keyboard and mouse, are present. Currently, Windows and macOS platforms are supported.
Please note that administrative privileges are required for the installation.
The following parameters are required to fully configure a client. These can be provided either during installation or afterward within the client. The necessary values can be found on the Installers page in the admin panel:
- Organization - The unique URL associated with your organization's tenant.
- Token - An installation token used to authorize the client installation.
Windows
Download KeystrikeClient.msi, a Microsoft Installer, from the admin panel, and install using one of the following methods:
Run the installer
- After downloading, you can run the installer directly by selecting it in your browser or double-clicking it in File Explorer.
- Optionally, enter the required parameters during installation.
Install using msiexec
To install the client with msiexec:
- Open a command prompt with administrator privileges.
- Run the following command :
msiexec /i <path_to_.msi> ORG="<organization_domain>" TOKEN="<install_token>" /qb
The exact command, pre-filled with the required parameters, can be copied from the admin panel.
Proxy
If the device can only connect to dispatch through an explicit proxy, an optional proxy parameter can be passed to the installer in the format PROXY="FQDN:port" .
msiexec /i <path_to_.msi> ORG="<organization_domain>" TOKEN="<install-token>" PROXY="FQDN:port" /qb
Transparent proxys are common, in that case this parameter is not needed.
Post install
The client is run automatically as soon as the install completes.
The client UI can be opened from the system tray in the bottom right corner of the user's main screen.
As clients connect to Keystrike’s Dispatch, they will appear in the admin panel.
For troubleshooting, the Windows client’s log files can be found at:
The installation will create 4 files in the %PROGRAMFILES%\Keystrike\Client folder:
- KeystrikeClientService.exe - runs as a Windows Service, running in the context of the local system account (SYSTEM), providing private key management and ensuring that a client worker is running for every user.
- KeystrikeClientWorker.exe - is run for each user's session, started by the Keystrike service. The worker runs as SYSTEM and creates attestations for user inputs and communicates with Dispatch.
- KeystrikeClientUI.exe - is run for each user's session, started by the Keystrike service. The UI process is run in the context of the user and communicates with the worker to display status information.
- client.toml - a config file. This file requires no manual modification.
Mac
Installed using KeystrikeClient.pkg, a notarized .pkg installer.
Run the installer
- After downloading, you can run the installer directly by selecting it in your browser or double-clicking it in Finder.
You will be prompted to provide Keystrike with Accessibility permissions.
- Click Open System Settings when prompted.
- Set the toggle next to Keystrike to the ON position.
Install with Terminal
To install the client with Terminal:
- Start a Terminal session, administrator privilages required.
- At the Terminal, run the install command echo "ORG=<organization_domain>" >> $HOME/.keystrike.conf && echo "TOKEN=<install_token>" >> $HOME/.keystrike.conf && sudo installer -pkg <path_to_.pkg> -target /
The command above can be copied from the setup page with needed parameters.
You will be prompted to provide Keystrike with Accessibility permissions.
- Click Open System Settings when prompted.
- Set the toggle next to Keystrike to the ON position.
Domain
For Mac clients, by default the username that will be created when the client is installed is in the format computer name>\<computer username>. However, it is possible to add a domain that will replace the computer name: <domain>\<computer username>. This is done by running the following modified install command in step 2 of Install with Terminal.
Proxy
If the device can only connect to dispatch through an explicit proxy, an optional proxy parameter can be passed to the installer in the format PROXY="FQDN:port"
Post install
The application is run automatically as soon as the install completes.
The client UI can be opened from the status menu bar in the top right corner of the user's screen.
As clients connect to Keystrike’s Dispatch, they will appear in the admin panel.
For troubleshooting, the Mac client’s log files can be found in a restricted folder at:
Uninstall
The mac client (version 3.7 and above) can be uninstalled by running the following command in Terminal:
The mac client (version 3.6 and below) can be uninstalled by running the following command in Terminal: