User GuidesAPI ReferenceRelease NotesEnrichment APIs
Doc HomeHelp CenterLog In

Setting the License Key

Provide the license key to Tamr Core.

Obtaining a License Key

To obtain a license key, contact Tamr Support at [email protected].

Setting The License Key

You use the unify-admin.sh command as the functional user to set the TAMR_LICENSE_KEY configuration variable. Different options for configuring this variable follow.

To use the CLI to set the license key:

  1. Change to the Tamr functional user: sudo su - <functional-user>

  2. Run the Tamr admin command config:set to set the variable TAMR_LICENSE_KEY to the license key value, as follows:

${TAMR_UNIFY_HOME}/tamr/utils/unify-admin.sh config:set TAMR_LICENSE_KEY="<license-key-value>"
  1. Restart Tamr Core and its dependencies. See Restarting Tamr Core.

To create a YAML file to set the license key:

  1. Create a new file on the Tamr deployment server, such as local-config.yaml, with the following contents:
---
TAMR_LICENSE_KEY: "<license-key-value>"
  1. Run the Tamr admin command config:set with the --file argument as follows:
${TAMR_UNIFY_HOME}/tamr/utils/unify-admin.sh config:set --file local-config.yaml
  1. Restart Tamr Core and its dependencies. See Restarting Tamr Core.

To update the license key in the future, see the following procedure.

To update a license key set by a configuration file:

If the license key is set by a YAML configuration file, you update the key by editing the file in which it is defined. If the license key reverts back to a previous key when you restart Tamr Core, this can indicate that you must update the key in a YAML file as follows.

  1. Navigate to the config directory on the Tamr Core deployment server (or directory where config files are read).
cd ${TAMR_UNIFY_HOME}/tamr/tamr/conf
  1. Find the config file, such as unify-custom-config.yaml or unify-config.yaml, which contains the current license key:
---
TAMR_LICENSE_KEY: "<license-key-value>"
  1. Back up the file and replace the license key value with the new license key in a new file of the same name.

  2. Restart Tamr Core and its dependencies. See Restarting Tamr Core.


Did this page help you?