Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Use the Settings page in Alert to configure encryption and proxies.

...

The configurable settings are discussed in the following sections.

...

Encryption configuration

Configure your encryption credentials by navigating to Settings > Encryption Configuration. It is best to use environment variables to configure encryption when deploying Alert. The environment variables are:

...

Info

In Alert versions 5.0.0 and later, the encryption salt secret file name is changed.
If you created the secret ALERT_ENCRYPTION_SALT in a version of Alert earlier than 5.x, you must rename the file to ALERT_ENCRYPTION_GLOBAL_SALT to use the same salt as in your previous version of Alert.

Providing encryption configuration in a file

Using Docker secrets, you can supply a file for the encryption password and a file for the encryption salt. The files must contain the text that is the password and salt to be used for encryption on the first line of the file. The files must have the following names so that Alert can find them.

  • ALERT_ENCRYPTION_PASSWORD

  • ALERT_ENCRYPTION_GLOBAL_SALT

Examples

docker secret create blackduck_ALERT_ENCRYPTION_PASSWORD alert_encryption_password.txt
where the first line in the alert_encryption_password.txt file contains the password.

...


docker secret create blackduck_ALERT_ENCRYPTION_GLOBAL_SALT alert_encryption_global_salt.txt
where the first line in the alert_encryption_global_salt.txt file contains the salt.

...

Using multiple configuration methods

If you use multiple methods to configure encryption, they are evaluated and used in the following order:

  1. Environment variables for encryption.

  2. The files in the docker secrets directory.

  3. The database volume if the encryption data was written to the volume.

Upgrading encryption considerations

When upgrading Alert, if the encryption password and salt were configured using environment variables in the previous version, then the encryption password and encryption salt values must be specified using environment variables for the new version of Alert. The environment variables must contain the same values as the corresponding password and salt variables in the previous version.

Note

Do not change the environment variable values when upgrading Alert. Additionally, changing the encryption password or salt requires all sensitive fields to be updated, as Alert is no longer able to decrypt them with the new values.

Proxy configuration

To configure your proxy environment,

...