Skip to main content

Installation & Configuration

All ILLiad client and server addons supported by Atlas Systems, including the Relais addons, follow the same installation process to ensure ease of implementation and consistency. For step-by-step procedures, see Installing and Configuring Server AddonsandInstalling and Configuring Client Addons.

Once the addon has been properly installed, the settings can be configured in the Addon Manager. The Relais addon requires additional configuration procedures for enabling encryption for patron data. See instructions listed below.

Configuring the Server Addon​

The following settings must be set for each specific library in BorrowDirect:

  • RelaisReturnsProxyUrls
  • AvailableLocallyButtonLabelText
  • LibrarySymbol
  • UserBarcodeMapping
  • UserPasswordMapping
  • ApiKey

Enabling Encryption for Patron Data​

The authentication endpoint of the Relais service has support for decrypting patron data, allowing sites to encrypt sensitive data before sending it to the Relais service. This encryption layer of the service uses RSA, and documentation on this layer of the Relais service can be found using the links below.

  • Authentication
  • Encryption

In order to enable encryption for this addon, you must copy a PEM-formatted RSA public key into the addon’s .ZIP archive. This file must be PEM-formatted and typically has a .key file extension. Once the public key file has been added to the addon’s .ZIP archive, the addon package must be re-deployed to the ILLiad server, using the Update button in the Server Addons tab in ILLiad Customization Manager.

Once the addon has been successfully re-deployed, change the addon’s new RSAPublicKeyFile setting. This value of this setting must be changed to the name of the RSA public key file that was added to the addon’s .ZIP archive. If this setting has a value, and the value points to a file that exists in the addon’s .ZIP archive and the file is a valid PEM-formatted RSA public key, then RSA encryption will be automatically enabled.

To update the RSA public key that is used by the addon, you must follow these same steps to:

  1. Add a new public key file to the addon’s .ZIP archive.
  2. Deploy the addon to the ILLiad server through ILLiad Customization Manager.
  3. Configure the addon setting so that it points to the new RSA public key file. If the name of the public key is the same as the old public key, then you do not have to change this setting.

To disable RSA encryption for this addon, temporarily or otherwise, you may just remove the value from the RSAPublicKeyFile setting. You may also redeploy the addon without an RSA public key file contained in the settings if you wish. Either of these actions will disable RSA encryption from the addon.