Update Service Client Service

The Update Service client service is a windows service running in the background which checks periodically for updates.

How to Install?

The client service is automatically installed with packages with update strategy set to automatic: For example, when installing a package with the Install-UscPackage PowerShell cmdlet and the update strategy (-UpdateStrategy) set to Automatic:

Install-UscPackage -Id 'example-package' -UpdateStrategy Automatic

During the installation, Update Service will check if the client service is already there. If not, it will be included in the installation. By default, the update strategy is set to manual. The update strategy can also be controlled via installer.

Warning

If the update strategy is changed from manual to automatic after installation, the service user may not have the necessary permissions to perform the update. Ensure the service user has the required permissions before switching to automatic updates.

Update Check Interval

By default, the client service checks for updates every 30 minutes. If you restart the service, it triggers an update check immediately. This can be useful when you're testing updates and don't want to wait for the next scheduled check.

You can change the update check interval by editing the following configuration file:

C:\ProgramData\LS Retail\GoCurrent\Client\ClientSettings.json

If the file doesn't exist, create it with the following content:

{
    "UpdateCheckInterval": 30
}

Set the UpdateCheckInterval value to the desired interval in minutes. Make sure the file is valid JSON.

Client Service User

During the client service installation, a new local administrator user named GoCurrentUser is created by default. This user is created with a random password that isn't stored.

You can use Set-UscClientServiceUser to assign a different user to the service, the user must be a local administrator on the machine.

Warning

If you change the service user after installation, the new user must have sufficient permissions to perform automatic updates, such as access to the database and any external resources used by the service.

Client Authentication

When Require Client Authentication is enabled on the server, the client service must authenticate with the server to receive updates.

As the client service is a background service, it doesn't have a user interface to enter credentials. Instead, the client service must use a personal access token (PAT) to authenticate with the server. By default, PAT is automatically generated from the logged in user, who installed the client service. To use a specific PAT, you can use the Set-UscClientServiceAccessToken cmdlet or to generate a new one.

The access token that's generated is valid for 12 months before it expires. You can revoke token from the server at any time.