SKP Connector Requirements and Installation (Standard)

Prev Next

This article contains Installation steps for the Standard Syniti Knowledge Platform Connector on Windows and Linux-based systems.

Installation Overview and Requirements

The Syniti Knowledge Platform Connector runs on Windows and Linux-based architectures and is installed and maintained using standard package management capabilities.

Supported Distributions:

  • Windows Server 2019 and above

  • Red Hat Enterprise Linux 9 - 10

  • Oracle Linux 9 - 10

  • SUSE Linux Enterprise Server 15 SP6 and SP7

  • Ubuntu 22.04, 24.04, 26.04

  • Amazon Linux 2023

Web Traffic

This is a list of common URLs to whitelist on any networks that are used for installation or upgrade of the Syniti Knowledge Platform. Refer to Web Traffic for a complete list.

Syniti does not host third-party components that are required for a unique environment.

The following URLs are dependent on the region of the tenant deployment. Only one is required. Please check the tenant domain and add the respective URL.

The following URLs are only required to install the connector and can be removed after installation:

Hardware Specifications

Syniti recommends the following:

  • 16GB RAM (8GB minimum) for the Syniti Knowledge Platform Connector and all associated services. Only Intel/AMD-based processors are supported.

  • A server with minimum 4 vCPUs (2 vCPUs minimum)

  • For storing logs, a server with a minimum of 10GB disk space post-installation

Install the SKP Connector

Register the SKP Connector in the Syniti Knowledge Platform

To register the SKP Connector:

  1. Verify you have Administrator permissions in the Syniti Knowledge Platform.

  2. Click the user avatar in the top right corner.

  3. Click Admin in the dropdown menu.

  4. Click SKP Connectors on the left.

  5. Click the Standard tab.

  6. Click Register SKP connector.

  7. Enter a name for the connector in the Name field.

    Note

    Name the SKP Connector with enough information to provide troubleshooting later, such as the IP address or other identifying information.

  8. Optionally, enter a Description for the connector.

  9. Click Save.

  10. In the dialog box that displays, click Copy secret key to copy the generated key.

    Important!

    It is essential to store the secret key in a secure location. This key cannot be regenerated after the dialog box is closed. However, the key can be rotated by following the steps in the Rotate the Key section below.

  11. Click the X to close the dialog box. The connector is saved, and the SKP Connector Details page displays.

Install the SKP Connector on a Linux Machine

`sudo` access is required on the Linux machine in order to install the SKP Connector.

To install the SKP Connector:

  1. Download the appropriate script for your operating system: Knowledge Platform Connector - Download

  2. Move the script to the machine where you want to install the Syniti Knowledge Platform Connector. Make note of the folder; it will be used again in the installation process.

  3. Run the script as sudo with: sudo bash <install_script> <flags>

    The following flag must be included:

    1. --key in the following format: “region:tenant_id:connector_id:secret”. This must be followed by the key returned when registering the new SKP Connector.

      1. Example:
        sudo bash syniti_connector_install_rhel.1.1.0sh --key “syniti.com:tnt_46eGdeJ9bH7yJq1shXK1579XsriF:skc_Q9aJJJ7U5dgbWQUgxikBLWbgRL8:kwHmMMcztiektBTFULqUAJ_23U20h2uKqZm4GuRNxEs”

    An optional flag is available to enable auto-update:

    1. --enable-auto-update with the SCHEDULE-TIME parameter accepts any valid systemd OnCalendar value: daily, weekly, monthly, etc.

      1. Example:
        sudo bash syniti_connector_install_rhel.1.1.0sh --key “syniti.com:tnt_46eGdeJ9bH7yJq1shXK1579XsriF:skc_Q9aJJJ7U5dgbWQUgxikBLWbgRL8:kwHmMMcztiektBTFULqUAJ_23U20h2uKqZm4GuRNxEs” —enable-auto-update daily

    2. --offline with the FILENAME of the rpm or deb package in order to proceed with an offline setup. The rpm and deb file should be placed in the same folder of the setup script.

    3. --custom-log-folder with the LOG-FOLDER the user can specify a custom folder for log files

    Use the --help flag to display the following instructions:

    1. script usage: ./syniti_connector_install_al2023.sh --key <KEY> [--enable-auto-update <SCHEDULE-TIME>] [--custom-log-folder <LOG-FOLDER>] [--offline <RPM-FILENAME>]

      REQUIRED:

       --key <KEY>    Key you obtained from SKT-UI (format: gateway_url:tenant_id:connector_id:secret)

      OPTIONAL:

       --enable-auto-update <SCHEDULE-TIME>    e.g. daily, weekly, monthly.

                                               Enable scheduled auto-updates for the Syniti Connector package using systemd timers.

                                               The SCHEDULE-TIME parameter accepts any valid systemd OnCalendar value.

                                               For more information, run the command:

                                               >> man systemd.time

                                               and check CALENDAR EVENTS section for details for particular scheduling options.

                                               This can be used if --offline option is not used (the auto-update feature needs network connectivity).

       --custom-log-folder <LOG-FOLDER>    Specify a custom folder for log files.

                                           If the path contains spaces, enclose it in double quotes.

                                           If not specified, the default log folder will be used (/var/log/syniti-connector).

       --offline <RPM-FILENAME>   Install the connector in offline mode using the specified RPM file.

                                  Skips repository setup and package installation steps.

                                  If you use this option, the auto-update feature cannot be enabled as it requires network connectivity to fetch updates.

      Examples:

       ./syniti_connector_install_al2023.sh --key your_key_here

       ./syniti_connector_install_al2023.sh --key your_key_here --enable-auto-update daily

       ./syniti_connector_install_al2023.sh --key your_key_here --custom-log-folder /path/to/logs

       ./syniti_connector_install_al2023.sh --key your_key_here --custom-log-folder "/path/to/logs with spaces"

       ./syniti_connector_install_al2023.sh --key your_key_here --offline your_rpm_file.rpm

      Example output from initial script execution:

      INSTALLING SYNITI CONNECTOR
      Adding Syniti RPM repository
      Detected operating system as amzn/2023.
      Checking for curl...
      Detected curl...
      Downloading repository file: https://packagecloud.io/install/repositories/syniti/syniti/config_file.repo?os=amzn&dist=2023&source=script
      done.
      Installing yum-utils...
      syniti_syniti-source                                                                                                                                                                                                                                      1.2 kB/s | 833  B     00:00    
      Package dnf-utils-4.3.0-13.amzn2023.0.6.noarch is already installed.
      Dependencies resolved.
      Nothing to do.
      Complete!
       
      WARNING:
      The yum-utils package could not be installed. This means you may not be able to install source RPMs or use other yum features.
       
      Generating yum cache for syniti_syniti...
      Generating yum cache for syniti_syniti-source...
       
      The repository is setup! You can now install packages.
      ✓ Syniti RPM repository added
      Installing Syniti Connector
      Dependencies resolved.
      ==========================================================================================================================================================================================================================================================================================
      Package                                                                   Architecture                                                    Version                                                           Repository                                                              Size
      ==========================================================================================================================================================================================================================================================================================
      Installing:
      syniti-connector                                                          x86_64                                                          1.0.8-1                                                           syniti_syniti                                                           19 M
       
      Transaction Summary
      ==========================================================================================================================================================================================================================================================================================
      Install  1 Package
       
      Total download size: 19 M
      Installed size: 39 M
      Downloading Packages:
      syniti-connector-1.0.8-1.x86_64.rpm                                                                                                                                                                                                                        15 MB/s |  19 MB     00:01    
      ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
      Total                                                                                                                                                                                                                                                      15 MB/s |  19 MB     00:01     
      Running transaction check
      Transaction check succeeded.
      Running transaction test
      Transaction test succeeded.
      Running transaction
        Preparing        :                                                                                                                                                                                                                                                                  1/1
        Installing       : syniti-connector-1.0.8-1.x86_64                                                                                                                                                                                                                                  1/1
        Running scriptlet: syniti-connector-1.0.8-1.x86_64                                                                                                                                                                                                                                  1/1
      Adding syniticonnector group and user...
      useradd: user 'syniticonnector' already exists
      Create the folder /var/log/syniti-connector and set permissions...
      Starting syniti-connector service...
      Created symlink /etc/systemd/system/multi-user.target.wants/syniti-connector.service → /usr/lib/systemd/system/syniti-connector.service.
       
        Verifying        : syniti-connector-1.0.8-1.x86_64                                                                                                                                                                                                                                  1/1
      ==========================================================================================================================================================================================================================================================================================
      WARNING:
        A newer release of "Amazon Linux" is available.
       
        Available Versions:
       
        Version 2023.10.20260302:
          Run the following command to upgrade to 2023.10.20260302:
       
            dnf upgrade --releasever=2023.10.20260302
       
          Release notes:
           https://docs.aws.amazon.com/linux/al2023/release-notes/relnotes-2023.10.20260302.html
       
        Version 2023.10.20260325:
          Run the following command to upgrade to 2023.10.20260325:
       
            dnf upgrade --releasever=2023.10.20260325
       
          Release notes:
           https://docs.aws.amazon.com/linux/al2023/release-notes/relnotes-2023.10.20260325.html
       
        Version 2023.10.20260330:
          Run the following command to upgrade to 2023.10.20260330:
       
            dnf upgrade --releasever=2023.10.20260330
       
          Release notes:
           https://docs.aws.amazon.com/linux/al2023/release-notes/relnotes-2023.10.20260330.html
       
      ==========================================================================================================================================================================================================================================================================================
       
      Installed:
        syniti-connector-1.0.8-1.x86_64                                                                                                                                                                                                                                                         
      Complete!
      ✓ Syniti Connector install complete
      Ensuring service is stopped for configuration
      Parse the provided key
      ✓ Key validation successful
      Update configuration file: /etc/syniti-connector/config.yaml
      ✓ Configuration updated successfully
      Enabling and starting Syniti Connector service
      Created symlink /etc/systemd/system/multi-user.target.wants/syniti-connector.service → /usr/lib/systemd/system/syniti-connector.service.
      ✓ Service enabled for auto-start
      ✓ Service started successfully
      Checking if service is running
      active
      ✓ Syniti Connector Service is Running
      Configure update service (systemd)
      ✓ Created systemd update service: /etc/systemd/system/syniti-connector-update.service
      ✓ Created systemd auto update timer: /etc/systemd/system/syniti-connector-update.timer
      Enable auto update timer
      Created symlink /etc/systemd/system/timers.target.wants/syniti-connector-update.timer → /etc/systemd/system/syniti-connector-update.timer.
      Checking if auto update timer is running
      active
      ✓ Syniti Connector Auto Update Timer is Running

  4. The final step of the script displays the Public Key of the SKP Connector. Copy this string of characters for registration in the Syniti Knowledge Platform.

Rotate the Key

The secret key generated in the SKP can be rotated any time the key needs to be refreshed. This does not cause disruption in service.

To rotate the secret key:

  1. From the SKP Connector Details page, click the More Actions icon.

  2. Select Rotate Key menu item.

  3. Click Confirm on the SKP Connecter Rotate Key dialog box. The key is rotated.

  4. Click Copy secret key in the SKP Connector Key Rotated dialog that displays.

    Note

    Key rotation does not cause interruption in service. The key must be added to the service, which must be restarted before the new key will be used.

  5. Apply the rotated key using the command below for the appropriate server:

    1. Linux:
      sudo /usr/bin/syniti-connector --config /etc/syniti-connector/config.yaml --update-key <new-key>

    2. Windows PowerShell with Administrator privileges:
      & "C:\Program Files\Syniti\Syniti Connector\syniti-connector.exe" --config "C:\Program Files\Syniti\Syniti Connector\config.yaml" --update-key <new-key>

    3. Windows Command Prompt (CMD) with Administrator privileges:
      "c:/Program Files/Syniti/Syniti Connector/syniti-connector" --config "C:\Program Files\Syniti\Syniti Connector\config.yaml" --update-key <new-key>

  6. Restart the service:

    1. Linux:
      sudo systemctl restart syniti-connector

    2. Windows:
      Open the Services software and restart the SKP Connector service.

Register the SKP Connector in the Syniti Knowledge Platform

To register the SKP Connector:

  1. Verify you have Administrator permissions in the Syniti Knowledge Platform.

  2. Click the user avatar in the top right corner.

  3. Click Admin in the dropdown menu.

  4. Click SKP Connectors on the left.

  5. Click the Standard tab.

  6. Click Register SKP connector.

  7. Enter a name for the connector in the Name field.

    Note

    Name the SKP Connector with enough information to provide troubleshooting later, such as the IP address or other identifying information.

  8. Optionally, enter a Description for the connector.

  9. Click Save.

  10. In the dialog box that displays, click Copy secret key to copy the generated key.

    Important!

    It is essential to store the secret key in a secure location. This key cannot be regenerated after the dialog box is closed. However, the key can be rotated by following the steps in the Rotate the Key section below.

  11. Click the X to close the dialog box. The connector is saved, and the SKP Connector Details page displays.

Install the SKP Connector on a Windows Machine

To install the SKP Connector on a Windows machine:

  1. Execute the installer file syniti-connector-setup.exe

  2. Enter the Connector Key.

  3. Optionally, select Enable auto update. If selected, choose to enable auto update on one of the following schedules:

    1. Daily by selecting the time of day in hours and minutes

    2. Weekly by selecting the time of day in hours and minutes, as well as the weekday

    3. Monthly by selecting the time of day in hours and minutes and the day of the month

  4. Click Next.

  5. Click Browse… to select a custom installation folder and log folder.

  6. Click Install.

  7. Click Close when the setup is complete.

Manually Update the Service

If auto-update is not selected on install, the service can be manually updated. Use the following commands to manually update the service:

  1. From PowerShell with Administrator privileges:
    & "C:\Program Files\Syniti\Syniti Connector\syniti-connector-update.ps1"

  2. From Command Prompt (CMD) with Administrator privileges:
    PowerShell -File "C:\Program Files\Syniti\Syniti Connector\syniti-connector-update.ps1"

Rotate the Key

The secret key generated in the SKP can be rotated any time the key needs to be refreshed. This does not cause disruption in service.

To rotate the secret key:

  1. From the SKP Connector Details page, click the More Actions icon.

  2. Select Rotate Key menu item.

  3. Click Confirm on the SKP Connecter Rotate Key dialog box. The key is rotated.

  4. Click Copy secret key in the SKP Connector Key Rotated dialog that displays.

    Note

    Key rotation does not cause interruption in service. The key must be added to the service, which must be restarted before the new key will be used.

  5. Apply the rotated key using the command below for the appropriate server:

    1. Linux:
      sudo /usr/bin/syniti-connector --config /etc/syniti-connector/config.yaml --update-key <new-key>

    2. Windows PowerShell with Administrator privileges:
      & "C:\Program Files\Syniti\Syniti Connector\syniti-connector.exe" --config "C:\Program Files\Syniti\Syniti Connector\config.yaml" --update-key <new-key>

    3. Windows Command Prompt (CMD) with Administrator privileges:
      "c:/Program Files/Syniti/Syniti Connector/syniti-connector" --config "C:\Program Files\Syniti\Syniti Connector\config.yaml" --update-key <new-key>

  6. Restart the service:

    1. Linux:
      sudo systemctl restart syniti-connector

    2. Windows:
      Open the Services software and restart the SKP Connector service.

Register the SKP Connector in the Syniti Knowledge Platform

To register the SKP Connector:

  1. Verify you have Administrator permissions in the Syniti Knowledge Platform.

  2. Click the user avatar in the top right corner.

  3. Click Admin in the dropdown menu.

  4. Click SKP Connectors on the left.

  5. Click the Standard tab.

  6. Click Register SKP connector.

  7. Enter a name for the connector in the Name field.

    Note

    Name the SKP Connector with enough information to provide troubleshooting later, such as the IP address of other identifying information.

  8. Optionally, enter a Description for the connector.

  9. Click Save.

  10. In the dialog box that displays, click Copy secret key to copy the generated key.

    Important!

    It is essential to store the secret key in a secure location. This key cannot be regenerated after the dialog box is closed. However, the key can be rotated by following the steps in the Rotate the Key section below.

  11. Click the X to close the dialog box. The connector is saved, and the SKP Connecter Details page displays.

Container Deployment with Helm

The SKP Connector container image is available through GitHub Container Registry (GHCR) and can be deployed using Helm.

  1. Download the Helm chart:

    helm pull oci://ghcr.io/backofficeassoc/charts/syniti-connector
    --untar
  2. Follow the steps below to complete the installation.

    Note

    After download, a comprehensive README.md file with all deployment instructions is available at syniti-connector/README.md Review these instructions for additional details, such as log storage, configuration updates, upgrades and rollbacks, security networking, and uninstall instructions.

    After download, a comprehensive README.md file with all deployment instructions is available at syniti-connector/README.mdReview these installation instructions OR follow the steps below.

Create the Configuration Secret

  1. Before creating the Secret, populate config.yaml using the values from your connector key. The key format is gateway_url:tenant_id:connector_id:secret.

    For example, the key api.syniti.com/services/wsg/ws:tnt_123:skc_123:SeCrE3t maps to:

    connector:
      connector_id: "skc_123"
      tenant_id: "tnt_123"
      gateway_url: "wss://api.syniti.com/services/wsg/ws"
      secret: "SeCrE3t"
    
    settings:
      heartbeat_interval_seconds: 10
      standby_websocket_check_seconds: 60
      max_standby_websocket_ttl_seconds: 300
      websocket_close_timeout_seconds: 3
      max_log_file_size_mb: 512
      max_backups_log_files: 14
      win_log_folder: ""
      linux_log_folder: ""
  2. Add the wss:// prefix to the gateway URL and enclose the secret in double quotes.

    kubectl create namespace syniti
    
    kubectl -n syniti create secret generic syniti-connector-config \
      --from-file=config.yaml=./config.yaml

    The chart mounts this secret at:

    /etc/syniti-connector/config.yaml

    The secret must exist in the installation namespace. Its default configuration key is confix.yaml.

    Note

    Kubernetes Secrets require appropriate access controls; Base64 encoding alone does not encrypt their contents.

Optional Deployment Values

  1. Create a non-sensitive values-environment.yaml only if you need to customize additional chart settings.

  2. Pass it to Helm with -f values-environment/yaml when installing or upgrading.

    image:
      repository: ghcr.io/backofficeassoc/syniti-connector
      tag: "REPLACE_WITH_IMAGE_VERSION"
      digest: ""
    
    config:
      existingSecret: syniti-connector-config
      secretKey: config.yaml
      revision: "1"
    
    imagePullSecrets: []
    
    logs:
      persistence:
        enabled: false
        existingClaim: ""

    Note

    An explicit image tag or digest is required. If a digest is supplied, it takes precedence over the tag.

Install

  1. Set SKP_CONNECTOR_VERSION to the published container image version.

    export SKP_CONNECTOR_VERSION=1.0.9
    
    helm upgrade --install syniti-connector \
      oci://ghcr.io/backofficeassoc/charts/syniti-connector \
      --namespace syniti \
      --set-string image.repository=ghcr.io/backofficeassoc/syniti-connector \
      --set-string image.tag="$SKP_CONNECTOR_VERSION" \
      --wait --timeout 300s

    Note

    Omitting --version installs the latest published chart version.

  2. If you created a values file in the Optional Deployment Values section above, add -f values-environment.yaml to the command. The command-line image tag overrides the tag in that file.

    Note

    Chart and image versions are independent.

  3. Check the deployment

    kubectl -n syniti get pods
    kubectl -n syniti logs deployment/syniti-connector

    No application health probes are configured. A successful rollout does not confirm that the connector can reach its external dependencies.

Update Connections to the New Connector

If you have Legacy SKP Connectors set up and in use, those connections must be updated to the Standard SKP Connector. Refer to Update Legacy Connections to the Standard SKP Connectors for detailed steps on this process.

Manually Upgrade the SKP Connector

Use these commands when automatic upgrades are not enabled, or when you want to force an upgrade manually. For an offline installation, use the local package file command; the package file and its dependencies must be available on the host.

Note

Replace the example package path with the actual path to the downloaded file.

Ubuntu

Online repository:

sudo apt-get update && sudo apt-get install --only-upgrade -y syniti-connector

Local package file:

sudo dpkg -i /path/to/syniti-connector.deb

RHEL

Online repository:

sudo yum update -y syniti-connector

Local package file:

sudo yum install -y /path/to/syniti-connector.rpm

SLES

Online repository:

sudo zypper refresh && sudo zypper update -y syniti-connector

Local package file:

sudo zypper -n --no-gpg-checks install -y /path/to/syniti-connector.rpm

Amazon Linux

Online repository:

sudo dnf upgrade -y syniti-connector

Local package file:

sudo dnf install -y /path/to/syniti-connector.rpm

Uninstall the SKP Connector

If necessary, use the instructions below to remove the Standard Syniti Connector from each supported operating system.

Note

Administrative privileges may be required on all platforms.

Ubuntu

sudo apt remove syniti-connector

RHEL

sudo yum remove syniti-connector

SLES

sudo zypper remove syniti-connector

Amazon Linux 2023

sudo dnf remove syniti-connector

Windows

Uninstall from the standard Windows applications menu using the following steps:

  1. Open Settings.

  2. Select Apps.

  3. Open Installed apps (or Apps & features, depending on Windows version).

  4. Locate Syniti Connector.

  5. Select Uninstall and complete the wizard.