v4 Worker/Listener Installation Guide
- Windows Server 2012+
- .NET Core 3.1 Hosting Bundle (see below for download link)
- SQL Server 2012+
- Service Broker enabled
- Cinchy Platform
Minimum requirements:
- 4 Gb of RAM
- 30 Gb of HDD space
- 2 CPU Cores
You need to set up the Service Broker by executing:
ALTER DATABASE [Your Cinchy Database Name] SET ENABLE_BROKER WITH ROLLBACK IMMEDIATE;
- 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.
Open appSettings.json in the Event Listener directory.
URL | Your Cinchy URL |
Password | For v4 this will be the desired user's password. |
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. |
Parameter | Value |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
- 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
- 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.
Open appSettings.json in the CLI Worker directory.
URL | Your Cinchy URL |
Password | For v4 this will be the desired user's password. |
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) |
Parameter | Value |
SqlServer | Fill in the connection string to the SQL server hosting the Cinchy database. |
- Open log4net.config
- Under <file value="" /> you can change where you want to write your logs to.
- 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
- 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.
- 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.