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.
Windows Server 2019 and above
Red Hat Enterprise Linux 9 - 10.0
Oracle Linux 9 - 9.7
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 16GB RAM for the Syniti Knowledge Platform Connector and all associated services. Only Intel/AMD-based processors are supported.
Install the SKP Connector
Register the SKP Connector in the Syniti Knowledge Platform
To register the SKP Connector:
Verify you have Administrator permissions in the Syniti Knowledge Platform.
Click the user avatar in the top right corner.
Click Admin in the dropdown menu.
Click SKP Connectors on the left.
Click the Standard tab.
Click Register SKP connector.
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.
Optionally, enter a Description for the connector.
Click Save.
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.
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:
Download the appropriate script for your operating system: Knowledge Platform Connector - Download
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.
Run the script as sudo with: sudo bash <install_script> <flags>
The following flag must be included:
--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.
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:
--enable-auto-update with the SCHEDULE-TIME parameter accepts any valid systemd OnCalendar value: daily, weekly, monthly, etc.
Example:
sudo bash syniti_connector_install_rhel.1.1.0sh --key “syniti.com:tnt_46eGdeJ9bH7yJq1shXK1579XsriF:skc_Q9aJJJ7U5dgbWQUgxikBLWbgRL8:kwHmMMcztiektBTFULqUAJ_23U20h2uKqZm4GuRNxEs” —enable-auto-update daily
--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.
Use the --help flag to display the following instructions:
script usage: ./syniti_connector_install_rhel.1.1.0sh --key <KEY> [--enable-auto-update <SCHEDULE-TIME>] [--offline <RPM-FILENAME>]
REQUIRED:
--key <KEY> Key you obtained from SKT-UI (format: region: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).--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_rhel.1.1.0sh --key your_key_here
./syniti_connector_install_rhel.1.1.0sh --key your_key_here --enable-auto-update daily./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.0-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.0-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.0-1.x86_64 1/1 Running scriptlet: syniti-connector-1.0.0-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.0-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.0-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
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:
From the SKP Connector Details page, click the More Actions icon.
Select Rotate Key menu item.
Click Confirm on the SKP Connecter Rotate Key dialog box. The key is rotated.
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.
Apply the rotated key using the command below for the appropriate server:
Linux:
sudo /usr/bin/syniti-connector --config /etc/syniti-connector/config.yaml --update-key <new-key>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>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>
Restart the service:
Linux:
sudo systemctl restart syniti-connectorWindows:
Open the Services software and restart the SKP Connector service.
Register the SKP Connector in the Syniti Knowledge Platform
To register the SKP Connector:
Verify you have Administrator permissions in the Syniti Knowledge Platform.
Click the user avatar in the top right corner.
Click Admin in the dropdown menu.
Click SKP Connectors on the left.
Click the Standard tab.
Click Register SKP connector.
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.
Optionally, enter a Description for the connector.
Click Save.
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.
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:
Execute the installer file syniti-connector-setup.exe
Enter the Connector Key.
Optionally, select Enable auto update. If selected, choose to enable auto update on one of the following schedules:
Daily by selecting the time of day in hours and minutes
Weekly by selecting the time of day in hours and minutes, as well as the weekday
Monthly by selecting the time of day in hours and minutes and the day of the month
Click Next.
Click Browse… to select a custom installation folder and log folder.
Click Install.
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:
From PowerShell with Administrator privileges:
& "C:\Program Files\Syniti\Syniti Connector\syniti-connector-update.ps1"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:
From the SKP Connector Details page, click the More Actions icon.
Select Rotate Key menu item.
Click Confirm on the SKP Connecter Rotate Key dialog box. The key is rotated.
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.
Apply the rotated key using the command below for the appropriate server:
Linux:
sudo /usr/bin/syniti-connector --config /etc/syniti-connector/config.yaml --update-key <new-key>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>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>
Restart the service:
Linux:
sudo systemctl restart syniti-connectorWindows:
Open the Services software and restart the SKP Connector service.
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.