MacOS Installation

Instructions for installing Keeper Gateway on MacOS

Overview

This document contains information on how to install, configure, and update your Keeper Gateway on MacOS.

Prerequisite

Prior to proceeding with this document, make sure you generated a Keeper Gateway One-Time Access Token in your Vault. For more information, visit the following page:

One-Time Access Token

Installation

Note: On macOS, the Gateway can only be installed as the local user and not as a service

Install Command

Executing the following command will install the Keeper Gateway:

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

Executing the following command will install and initialize the Keeper Gateway:

curl -fsSL https://keepersecurity.com/pam/install | bash -s -- --token XXXXX

Note: Replace XXXXX with the One-Time Access Token supplied by the Vault screen, more information here

Installation Location

The gateway will be installed in the following location:

/usr/local/keeper-pam/gateway

An alias gateway is also created:

gateway -> /usr/local/bin/gateway 

Starting the Gateway

After installation, To start the gateway on the local Terminal, type:

gateway start

If the Gateway was never initialized, you will be prompted for an One-Time Access Token, more information here

Keeper Gateway Configuration File

The Keeper Gateway configuration file contains a set of tokens that includes encryption keys, client identifiers, and destination server information used to authenticate and decrypt data from the Keeper Secrets Manager APIs. This configuration file is created from the Gateway One Time Access Tokens and have a one to one relationship with client devices.

The gateway configuration file is stored in the following location:

<User>/.keeper/gateway-config.json

Keeper Gateway Log files

Logs that contain helpful debugging information are automatically created and stored on the local machine.

The gateway log files are stored in the following location:

<User>/.keeper/logs/

Upgrading

To upgrade the Keeper Gateway service:

  1. Stop the current Gateway service

  2. Install the new binary by executing the following command:

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

Uninstalling

Executing the following command will uninstall the Keeper Gateway:

curl -fsSL https://keepersecurity.com/pam/uninstall | bash -s

Last updated