Help Center

Menu

plugin.[pluginId].encrypted.[secretKey]

Background

Plugin encrypted keys facilitate the storage of secret information (such as passwords and tokens) for use in a plugin.

Any data stored in an encrypted key will be automatically encrypted and decrypted by the plugin. The administration dashboard will automatically obfuscate the value of any encrypted fields.

An encrypted plugin key is specified using the following format:

plugin.PLUGIN_ID.encrypted.KEY=VALUE

where:

  • PLUGIN-ID is the ID of the plugin.

  • KEY is the key name.

  • VALUE is the value that is stored in an encrypted format.

Setting the key

Set this configuration key in the results page (preferred) or search package configuration.

Use the configuration key editor to add or edit the plugin.[pluginId].encrypted.[secretKey] key, and set the value. This can be set to any valid ConfigPassword value.

Default value

This field is not set by default

Examples

Configure the plugin 'exampleplugin' to have a secret token called 'token'.

plugin.exampleplugin.encrypted.token=password2