Upgrade
This chapter details how to update an existing KeySafe 5 install to the latest version.
Upgrade the KeySafe 5 Service Deployment from v1.7.0
| Before upgrading, Entrust recommends backing up your data and configurations as described in KeySafe 5 Service Backup. |
-
Perform the following steps for your operating system:
On Linux:
-
Run
sudo /opt/nfast/keysafe5/server/sbin/install -uto uninstall the existing KeySafe 5 Service. -
Download and unpack the KeySafe 5 1.8.0 package and navigate to the
keysafe5-servicedirectory. -
Run
sudo tar -C / -xf /path/to/keysafe5-server-1.8.0-Linux.tar.gzto unpack the KeySafe 5 Service binaries and associated scripts into the/opt/nfast/directory. -
Run
sudo /opt/nfast/keysafe5/server/sbin/installto install the KeySafe 5 Service.
On Windows:
-
Stop the KeySafe 5 Service using Windows Service Manager.
-
Open the Control Panel and select Programs and Features.
-
Select the nShield KeySafe 5 Service package.
-
Select Uninstall and follow the on-screen instructions.
-
Download and unpack the KeySafe 5 1.8.0 package and navigate to the
keysafe5-servicedirectory. -
Double-click
keysafe5-server-1.8.0-windows.msiand follow the Installation Wizard.
-
-
Open the KeySafe 5 WebUI at
https://127.0.0.1:18080by default, and verify that your existing KeySafe 5 data is available. -
Upgrade each KeySafe 5 Agent as described in Agent Upgrade.
Configuration File Changes
The following sections describe the configuration parameters that have been updated or added in this version of the KeySafe 5 Service.
The config.yaml.example file included with this version lists these parameters and their default values.
To change any of these settings from their default values, copy the relevant parameters into your existing config.yaml file and restart the KeySafe 5 Service.
Default values apply to any configuration parameters not explicitly set in config.yaml. For details on configuration items, see KeySafe 5 Service Configuration.
Existing configuration items that have been updated:
| Parameter | Description | Default Value |
|---|---|---|
|
Type of database to use. This parameter now supports |
|
|
Timeout for database requests has increased from |
|
The new configuration items are as follows:
| Parameter | Description | Default Value |
|---|---|---|
|
Maximum time to wait for each sub-service to pass its initial health check during startup. Increase this value if sub-services are slow to start in your environment. If a sub-service does not become healthy within this period, the gateway will report a startup failure. |
|
|
Set this parameter to |
|
|
List of additional domains to add to the Content-Security-Policy |
`` |