Windows Installation
Instructions for installing Keeper Gateway on Windows
Last updated
Was this helpful?
Instructions for installing Keeper Gateway on Windows
Last updated
Was this helpful?
This document contains information on how to install, configure, and update the Keeper Gateway on Windows.
Prior to proceeding with this document, make sure you created a Gateway device.
Download the new installer preview version: 64-bit Installer or 32-bit Installer
Upon installation of the service, select "Enter a Keeper One-Time Access Token" and supply the token provided by when you created a Gateway on the Vault. After installation, the service will automatically start up and register with the Keeper cloud.
The default installation location is the following:
We recommend that the Keeper Gateway is installed as a service.
After selecting the installation location, you will be prompted with the following:
Setup Options Details:
Install Windows service - Installs the gateway as a window service
Use service account - If checked, use the specified service account, otherwise the account installing the gateway will be used
Start Windows service - if checked, start the Keeper Gateway service immediately after installation
Turn on debug logging - Enable verbose logging on the gateway log files
If "Use service account" is specified you will be prompted to enter the valid credentials of the desired service account:
The final step prior to successfully installing the Keeper Gateway as service is to enter the One-Time Access Token:
After clicking "Next", click "Install" in the prompted screen to successfully install the Keeper Gateway.
After installing and running the Keeper Gateway as a service, this service can be accessed and easily managed within the Windows Services Manager as "Keeper Gateway"
The Keeper Gateway configuration file contains a set of tokens that includes encryption keys, client identifiers, and tenant server information used to authenticate and decrypt data from the Keeper Secrets Manager APIs. This configuration file is created from the One-Time Access Token generated when you created the Gateway.
If the Keeper Gateway is installed and running as a service, the gateway configuration file is stored in the following location:
If the Keeper Gateway is installed locally and not running as a service, the gateway configuration file is stored in the following location:
Logs that contain helpful debugging information are automatically created and stored on the local machine.
If the gateway is running as a service, the gateway log files are stored in the following location:
If the gateway is not running as a service, the gateway log files are stored in the following location:
To activate verbose logging:
Go to Windows Services > Keeper Gateway > Properties
Stop the service
Set the "Start parameters" to: --debug
or -d
Start the service by clicking on "Start" Do not click "OK" without first starting the service as it will not persist the Parameter setting
To upgrade, stop the service, install the latest version and then start the service.
Back up your gateway-config.json
configuration file
Uninstall Keeper Gateway from "Add and remove programs"
Install Keeper Gateway (do not select "Enter a Keeper One-Time Access Token")
Configure your Keeper Gateway installation to automatically check for updates, ensuring it stays up-to-date with the latest version.
This section provides instructions for performing a silent installation of the Keeper Gateway on Windows systems. Silent installation allows the setup process to run in the background without displaying any user interface or messages.
To install the Keeper Gateway silently, use the following command in your command prompt or script:
Replace <TOKEN>
with the token generated for your Keeper Gateway installation.
Existing Configuration: If you have previously installed Keeper Gateway and wish to use the existing configuration, you can bypass the token entry by using:
The following other options may be used:
Installation Log File: To generate a log file during the installation process, use the following option and specify the desired log file path:
If you prefer to run the Keeper Gateway under a specific Windows service account, use the following options to specify the account details:
Replace <ACCOUNT USERNAME>
and <ACCOUNT PASSWORD>
with the credentials of the service account you intend to use.
To enable the Auto Updater feature, allowing Keeper Gateway to automatically check for and apply updates, use the following option:
To uninstall the service:
Uninstall Keeper Gateway from "Add and remove programs"
If desired, delete the private configuration .json file