Auto Updater

Instructions for installing and configuring the Auto Updater for the Keeper Gateway.

Auto Updater is supported only on Versions 1.4.0 or later of the Keeper Gateway

Overview

This document contains information on how to install & configure the Auto Updater for your Keeper Gateway installation. The Auto Updater makes periodic checks to update your Keeper Gateway to the latest version.

By default, the Auto Updater is disabled to prevent unexpected updates.

However, Keeper recommends enabling the Auto Updater to ensure you receive the most recent security and functionality enhancements. The Auto Updater verifies all Keeper Gateway downloads by checking the GPG signature of hash value, which are then utilized to checksum each file.

Auto Updater Installation

Prerequisites

  • Ensure that you have administrative privileges on the system.

  • Version 1.4.0 or later of Keeper Gateway is required.

Installation on Linux

Install with Keeper Gateway Installer

Execute the following command to download and run the installer. The --autoupdate parameter is necessary for installing the auto updater in addition to Keeper Gateway.

sudo curl -fsSL https://keepersecurity.com/pam/install | bash -s -- --autoupdate

Click the following link for details on other Linux installation options:

Linux Installation

Install with existing Keeper Gateway

Install Auto Updater on existing installation by executing the following Keeper Gateway command:

sudo keeper-gateway autoupdate enable

Verify Installation (Optional)

Verify that the Auto Updater has been installed successfully by executing the following Keeper Gateway command:

sudo keeper-gateway autoupdate status

Installation on Windows

Install with Keeper Gateway Installer

  • Download the latest version of the Gateway installer which includes the Auto Updater from the official website.

  • Double-click the installer file to launch the installation wizard and follow the on-screen instructions. Click the following link for details on other Windows installation options:

Windows Installation

  • During installation, check the box "Enable automatic updates". This setup option will create a new Task Scheduler task for auto updating the Gateway.

Install with existing Keeper Gateway

  • Open a command prompt as Administrator.

  • Install Auto Updater with the following Keeper Gateway command:

keeper-gateway autoupdate enable

Verify Installation (Optional)

  • Open a command prompt as Administrator.

  • Verify that Auto Updater has been installed successfully by executing the following Keeper Gateway command:

keeper-gateway autoupdate status

Auto Updater Status

Prerequisites

  • Ensure that you have administrative privileges on the system.

  • Version 1.4.0 or later of Keeper Gateway is required.

Status on Linux

Check the Auto Updater status by executing the following Keeper Gateway command:

sudo keeper-gateway autoupdate status

Status on Windows

  • Open a command prompt as Administrator

  • Check the Auto Updater status by executing the following Keeper Gateway command:

keeper-gateway autoupdate status

Auto Updater Configuration

Prerequisites

  • Ensure that you have administrative privileges on the system.

  • Version 1.4.0 or later of Keeper Gateway is required.

  • Check that Auto Updater is enabled using the steps in the Status section:

Auto Updater Status

Configuration on Linux

Edit the crontab that runs Auto Updater.

sudo crontab -e

Here is an example of the default crontab entry that checks for updates every hour:

0 * * * * /usr/local/bin/keeper-gateway-update --trust
  • The first part 0 * * * * is the crontab expression which will cause execution to occur every hour at 0 minutes.

  • The second part is the update command keeper-gateway-update

  • The option --trust causes explicit trust of the Keeper Gateway GPG public key for verification of downloaded install files.

Configuration on Windows

Configure the update frequency and other settings with the following steps:

  • Run taskschd.msc to open Windows Task Scheduler.

  • In the left pane double-click on Task Scheduler Library -> Keeper -> Gateway -> AutoUpdate to show the Auto Updater Task.

  • In the upper middle pane double-click on the AutoUpdate Task with the name of the current version and click on the Triggers menu tab.

  • Click Edit... to change when the Auto Updater checks for a new update to install. The default is to "Repeat task every 1 hour indefinitely" as shown below.

Auto Updater Removal

Prerequisites

  • Ensure that you have administrative privileges on the system.

  • Version 1.4.0 or later of Keeper Gateway is required.

Removal on Linux

Remove Auto Updater by executing the following Keeper Gateway command:

sudo keeper-gateway autoupdate disable

Removal on Windows

Remove Auto Updater with the following steps:

  • Open a command prompt as Administrator.

  • Remove Auto Updater with the following Keeper Gateway command:

keeper-gateway autoupdate disable

Troubleshooting

Check the status of the Auto Update

keeper-gateway autoupdate status

Logging in the Gateway Auto Updater

To assist with diagnosing issues or monitoring the status of updates, the Gateway Auto Updater generates two types of logs. These logs are subject to rotation policies to avoid overuse of disk space.

Linux

Log Location

All log files for Linux are located in /var/log/keeper-gateway

Log Files

  1. Update Logs: Any logs generated during an update will be timestamped and stored as update_YYYY-MM-DD_HH-MM-SS.log.

  2. Last Update Check: The file last-update-check.log contains information regarding the most recent check for updates.

Windows

Log Location

The log files for the Gateway Auto Updater are located in \ProgramData\KeeperGateway\install

Log Files

  1. Update Logs: Any logs generated during an update will be timestamped and stored as YYYY-MM-DD_HH-MM-SS.log

  2. Last Update Check: The file last-update-check.log contains information regarding the most recent check for updates.


Last updated