v4 Worker/Listener Installation Guide
Pre-Requisites
Windows Server 2012+
.NET Core 3.1 Hosting Bundle (see below for download link)
SQL Server 2012+
Service Broker enabled
Cinchy Platform
Server Sizing
Minimum requirements:
4 Gb of RAM
30 Gb of HDD space
2 CPU Cores
SQL Service Broker Setup
You need to set up the Service Broker by executing:
Event Listener Setup
Installation
Extract content of the Cinchy Event Listener zip file to <your event listener folder>
Execute create-cinchy-event-listener-windows-service.ps1 PowerShell script. Pass in filePath parameter -filePath <Your Listener/Worker Path> to the agent.exe file. The script is in the installation directory.
Listener Configuration
Open appSettings.json in the Event Listener directory.
Client Settings
URL | Your Cinchy URL |
Password | For v4 this will be the desired user's password. |
AppSettings
Parameter | Value |
Domain | Cinchy Web URL (ex. https://cinchy.net/Cinchy) |
AuthServiceDomain | Cinchy SSO URL (ex. https://cinchy.net/CinchySSO) |
UserName | Username for a Cinchy user that has access to read from the [Cinchy].[Listener Configs] table |
Password | Encrypted password for the user above (you can use the CLI to encrypt the password) |
GetNewListenerConfigsInterval | (seconds) How often the listener polls for new configs in the [Cinchy].[Listener Configs] table. Default is 60. |
LogLevel | Logging level for the listener. Recommended to be set to "Info" |
LogDirectory | Directory for storing the logs. |
ConnectionStrings
Parameter | Value |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
Starting the Service
Open the Run box (Windows + R)
Open services.msc
In the list of services, find the Cinchy Event Listener service
Right click on the service and click Start
CLI Worker Setup
Installation
Extract content of the Cinchy.CLIWorker.zip file to C:\<your cli worker folder>
Execute create-cinchy-cli-worker-windows-service.ps1 PowerShell script. Pass in filePath parameter. filePath = path to the Cinchy.CLI.exe file. The script is in the installation directory.
Worker Configuration
Open appSettings.json in the CLI Worker directory.
Client Settings
URL | Your Cinchy URL |
Password | For v4 this will be the desired user's password. |
AppSettings
Parameter | Value |
Domain | Cinchy Web URL (ex. https://cinchy.net/Cinchy) |
Server | URL to the Cinchy instance to which you want to sync the messages to without the protocol (ex. cinchy.net/Cinchy) |
UserName | Username for a Cinchy user that has access to read from the [Cinchy].[Listener Configs] table |
Password | Encrypted password for the user above (you can use the CLI to encrypt the password) |
Model | "Cinchy". This is the model for the CLI. |
TempDirectory | Temp directory for the CLI to store files. |
DatabaseName | Name of the database (same as the one in the ConnectionStrings below) |
ConnectionStrings
Parameter | Value |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
Log Settings
Open log4net.config
Under <file value="" /> you can change where you want to write your logs to.
Starting the Service
Open the Run box (Windows + R)
Open services.msc
In the list of services, find the Cinchy CLI Worker service
Right click on the service and click Start
Uninstall Instructions
Event Listener
Stop the Cinchy Event Listener service
Execute remove-cinchy-event-listener-windows-service.ps1 located in installation directory. Machine reboot may be required to complete the removal process.
CLI Worker
Stop the Cinchy CLI Worker service
Execute remove-cinchy-cli-workerwindows-service.ps1 located in installation directory. Machine reboot may be required to complete the removal process.
Last updated
