Breadcrumbs

CI Sync Agent Installation Guide for Windows Service Setup

CI Sync Agent - Installation Guide

This guide is an interim solution before our new agent installer process is complete. The link to download the agent files will be provided by Syncfish.

What You’re Installing

The CI Sync Agent runs as a Windows service that connects to your Temporal server and executes scheduled workflows. Installation takes about 5 minutes and requires local administrator access. This is the next generation CI Sync agent.

Prerequisites

  • Windows 10/11 or Windows Server (64-bit)

  • Local administrator rights on the machine

  • PowerShell (built in to Windows)

  • Network access from this machine to your Temporal server address

  • The following values ready to enter during setup:

    • Agent name – a friendly name for this agent instance

    • Instance URL – your organization's instance URL (e.g. <https://yourcompany.syncfish.app)>

    • Temporal server address – e.g. aksause01-temporal.syncfish.app:443

    • Temporal namespace

    • Authentication type – either:

      • Client secret: Application (client) ID, Tenant ID, Client ID, and Client Secret, or

      • Certificate: Certificate store (CurrentUser or LocalMachine) and certificate name

Step 1 - Extract the Package

Extract the provided .zip file to a folder of your choice (e.g. C:\\temporal-remote-agent).

image-20261026-053349.png


Step 2 - Install the Service

  1. Right-click PowerShell and choose Run as Administrator.

  2. Navigate to the extracted folder:

    PowerShell
    cd "C:\temporal-remote-agent"

  3. Run the installer:

    PowerShell
    powershell -ExecutionPolicy Bypass -File .\install-agent-service.ps1

This copies the agent files to C:\Program Files\syncfish\CISync Agent NG\ and registers the CISync Agent NG Windows service (the service is created but not started yet).

Optional: If your organization requires the service to run under a specific Windows account, change the service "Log On" identity in Services (services.msc) now. That account will need Modify permission on the install folder and

permission on the plugins and extractor_plugins subfolders.

Step 2.1 - Change the service “Log On” identity

  1. Open Services

  2. Right click CISync Agent NG and choose properties

    image-20261026-053906.png

  3. Click the Log On tab

    image-20261026-053946.png

  4. Configure the required account

Step 2.2 - Update the permissions on plugins and extractor_plugins folders

  1. Navigate to where CISync Agent NG is installed C:\Program Files\syncfish\CISync Agent NG

  2. For each of the folders (plugins and extractor_plugins)

    1. Right click the folder and choose properties

    2. Click the Security tab

    3. Click edit

    4. Find and and select the correct user

    5. Tick allow for Full control

    6. Click Apply and then OK

      image-20261026-054324.png

Step 3 - Start the Service and Open the Config UI

Still in the elevated PowerShell window:

PowerShell
powershell -ExecutionPolicy Bypass -File .\start-agent-service.ps1

This starts the service and automatically opens the configuration page at **http://127.0.0.1:8787** in your browser.

image-20261026-053701.png

Step 4 - Configure the Agent

In the Config UI, fill in the following fields:

Field

Description

Log level

Leave as Info unless asked to change it

Agent name

A friendly identifier for this agent

Instance URL

Your organization's instance URL

Authentication type

Client secret or Certificate

Application ID

App registration (client) ID

Tenant ID

Azure AD / identity provider tenant ID

Client ID

Client ID for authentication

Client secret (if using Client secret auth)

Stored securely; hidden after saving

Certificate store / name (if using Certificate auth)

e.g. CurrentUser, plus the certificate's subject name

Temporal server address

e.g. aksause01-temporal.syncfish.app:443

Temporal namespace

e.g. default

Click Save and apply. The page will show the agent's runtime status, confirming the worker has started.


Verifying the Install

  • Service status: open Services (services.msc) and confirm CISync Agent NG shows Running.

  • Logs: C:\\Program Files\\syncfish\\CISync Agent NG\\logs\\

Uninstalling

From an elevated PowerShell session in the same folder:

PowerShell
powershell -ExecutionPolicy Bypass -File .\uninstall-agent-service.ps1

Add -KeepFiles if you want to remove the service but keep the installed files for diagnostics:

PowerShell
powershell -ExecutionPolicy Bypass -File .\uninstall-agent-service.ps1 -KeepFiles

Support

If you run into issues during install, send us:

  • The log file at C:\\Program Files\\syncfish\\CISync Agent NG\\logs\\cisync_agent.log

  • The Windows version and whether the service account was changed from the default