Installing the Hub Email Extension in a non-Dockerized Environment

Non-Dockerized Hub Email Extension installation

To install the Hub Email Extension in a non-Dockerized environment (Black Duck Hub versions 3.6 and lower), use the following procedure. Configuration and usage of the Hub Email Extension is the same for both environments; the only difference is the installation routine.

The non-Dockerized setup of the Hub Email Extension consists of three phases:

Download
Installation
Configuration

These phases are detailed in the following sections.

Installing on a Hub server

The following topics are specific to installations on a Hub server.e

Hub server installation prerequisites

Before you install the Hub Email Extensions, ensure that:

You are running Black Duck Hub version 3.4 or higher.
You know the host name and port for the Hub server.
You know the host name and port for your email server.
You have a user account with administrator privileges on the Hub system.
You have connectivity to the internet.
You have user rights to copy files onto your Hub system.
You are a root user, or a user with Sudo access rights for configuring IP tables.

Installation location

After you have downloaded the zip file as described in Downloading the Hub Email Extension on page , you must copy the zip file onto the Hub server. The default installation location for all Black Duck Hub software is the /opt/blackduck/ directory. Typically, this includes hub/ and install/ sub-directories. For the email extension, you must create a sub-directory in the /opt/blackduck directory specifically for the email extension.

To create the install directory, run the following commands:

cd /opt/blackduck
mkdir extensions
Copy the file hub-email-extension-<version>.zip into the /opt/blackduck/extensions directory.
cd /opt/blackduck/extensions
unzip hub-email-extension-<version>.zip

You now have the directory /opt/blackduck/extensions/hub-email-extension-<version> on the Hub server.

Installation permissions and ownership

Before proceeding further, you must make sure that the owner of the /opt/blackduck/extensions/hub-email-extension-<version> directory is the blckdck:blckdck user and group. Additionally, the shell script used to start and stop the email extension must have its permissions changed to allow it to execute.

To perform these steps, run the following Linux commands:

Change the ownership of the directory:

chown -R blckdck:blckdck /opt/blackduck/extensions/hub-email-extension<version>
Change the permissions:

chmod 755/opt/blackduck/extensions/hub-email-extension-<version>/bin/email_extension.sh

Docker compose file considerations

At the end of the docker-compose file, you must modify the existing volume list and add the newly-created email-extension-config volume. Use the following code.

Setting Java home

For the Hub Email Extension to work, the JAVA_HOME environment variable must be set. Since the extension is installed on a Hub server, it can use the same Java Runtime Environment (JRE) used by the Hub server. To configure this, the hub-email-extension script file must be edited to set the JAVA_HOME environment variable.

Do not export the JAVA_HOME variable in your terminal, as it will only be a valid environment variable for that terminal session.

To configure JAVA_HOME:

Execute the command:
Locate the APP_BASE_NAME in the file as follows:
Edit the file to define JAVA_HOME='/opt/blackduck/hub/jre/CurrentVersion/' as follows:
Save the changes to the hub-email-extension script.