basicAuthCredentials

basicAuthCredentials

This configuration option was added in version 6.0.0 of Profound.js.

Description

Specifies the path to a file containing basic authentication credentials used by the /reloadAPI and /reloadWorkspaces hot reload routes (see Hot module reloading).

The credentials file is created by the store_credentials.js command line utility, which encrypts the user id and password. Profound.js decrypts the file at startup and uses the first line as the user and the second line as the password. For an example of using the utility, see Setting up a Connection to a Remote IBM i Instance.

Requirements

  • An encryptionKey must be configured. Without one, the instance reports a configuration error and does not start;

  • The path may be absolute, or relative to the Profound.js installation directory;

  • The file must be readable and decryptable with the configured key, otherwise startup fails with an error identifying which of the two steps failed.

Example

Protect the hot reload routes with credentials stored in an encrypted file in the installation directory:

basicAuthCredentials: "/profoundjs/basicAuthCredentials"

For information on how to modify this setting, see Configuration File.