Installation

Install the Connector as Service

Windows Service

Install the Windows Service

  • Set the CONNECTOR_HOME value in the file service/windows/<PRODUCT_NAME>.xml.

<env name="CONNECTOR_HOME" value="c:\path\to\connector_installation" />

  • Install the Service as administrator

<PRODUCT_NAME>.exe install

  • Start the Service

<PRODUCT_NAME>.exe start

Uninstall the Windows Service

  • Uninstall the Service

<PRODUCT_NAME>.exe uninstall

Linux/Unix Service

init.d

Install the init.d Service

  • Set the CONNECTOR_HOME value in the file service/unix/<PRODUCT_NAME>.init.

CONNECTOR_HOME=/path/to/connector_installation

  • Copy the init file to the directory /etc/init.d/<PRODUCT_NAME>.

sudo cp service/unix/<PRODUCT_NAME>.init /etc/init.d/<PRODUCT_NAME>

  • Install Script Links

update-rc.d <PRODUCT_NAME> defaults

  • Start the Service

service <PRODUCT_NAME> start
Uninstall the init.d Service

  • Stop the Service

service <PRODUCT_NAME> stop

  • Remove the init file from /etc/init.d/<PRODUCT_NAME>.

 sudo rm -f /etc/init.d/<PRODUCT_NAME>

  • Remove Script Links

update-rc.d -f <PRODUCT_NAME> remove

system.d

Install the system.d Service

  • Edit the file service/unix/<PRODUCT_NAME>.service. Adjust the values for WorkingDirectory and ExecStart.

WorkingDirectory=CONNECTOR_HOME
ExecStart=CONNECTOR_HOME/bin/connector

  • Copy the service file to the directory /etc/systemd/system.

sudo cp service/unix/<PRODUCT_NAME> /etc/systemd/system

  • Reload the system daemon

sudo systemctl daemon-reload

  • Enable the Service at boot

sudo systemctl enable <PRODUCT_NAME>.service

  • Start the Service

sudo systemctl start <PRODUCT_NAME>.service
Uninstall the system.d Service

  • Stop the Service

sudo systemctl stop <PRODUCT_NAME>.service

  • Disable the Service at boot

sudo systemctl disable <PRODUCT_NAME>.service

  • Remove the service file

sudo rm /etc/systemd/system/<PRODUCT_NAME>.service

Enable SSL

To enable SSL for all connector endpoints, you can modify the ssl.properties located under config directory of the connector installation. Uncomment the lines and adjust the store name, alias and the store password.

ssl.properties
#server.ssl.enabled=true
#server.ssl.key-store-type=PKCS12 // Supported are PKCS12 and JKS(deprecated)
#server.ssl.key-store=connector.p12
#server.ssl.key-store-password=changeit
#server.ssl.key-alias=connector

The connector contains a default key store connector.p12 located in the root directory of the installation containing a self-signed certificate with alias connector. Adjust the properties server.ssl.key-store, server.ssl.key-store-password and server.ssl.key-alias to use your own certificate and key store.

To use the encrypted password for the property server.ssl.key-store-password use the Password Encryptor Tool.

The connector supports following SSL protocols: TLSv1.2, TLSv1.3.
The connector requires a manual restart to apply the changes in ssl.properties.

Upgrade Guide

Follow the following instruction to upgrade your installation to latest version.

  1. Stop the running connector. If your connector runs as service, follow stop and uninstall the service (See: Install the Connector as Service).

  2. Copy the config directory located under root directory of your old installation to the root directory of the new installation.

  3. Copy the license file license.lic located under root directory of your old installation to the root directory of the new installation.

  4. Copy all custom stages from the stages directory located under the root directory of your old installation to the stages directory of the new installation. Any stage which already exists in the new installation does not need to be copied.

  5. Install and Start the new connector (See: Install the Connector as Service).