Skip to main content

Windows quickstart

This article installs Clustron Zaris on a Windows host, then creates a store you can connect to. The installer sets up the Management Service, the Web Console, and the PowerShell modules; you then activate a workspace, create a store, and connect. Everything runs on one machine, and the client API is the same one every other mode uses.

note

In-process mode requires no installation. If you only want a store inside your .NET application, follow Run in-process instead.

Prerequisites​

You need a Windows machine with administrative privileges. The installer registers services and opens firewall ports, so it must be run as Administrator.

1. Download and extract​

Download the Windows package from the Clustron downloads page:

https://clustron.io/install/

The package is named with the release version, for example:

clustron-zaris-1.1.0-win-x64.zip

Extract the ZIP to a folder of your choice, for example C:\clustron.

2. Run the installer as Administrator​

In the extracted folder, run install.cmd as Administrator. Right-click install.cmd and choose Run as administrator, or run it from an Administrator terminal:

.\install.cmd
warning

The installer must be run as Administrator. Without administrative privileges, installation fails.

This registers the Management Service on port 7801, the Web Console on port 7810, and the PowerShell modules used to manage stores.

3. Create a store​

To create a store, you first connect a workspace to the Management Service and activate it, then create the store. Store creation cannot happen before a workspace is active.

First, point a workspace at the local Management Service and activate it:

# Point a workspace at the local Management Service and activate it
New-ZrWorkspace -Name local -Managers "localhost:7801" -Activate

Then create the store. In supervisor mode the Management Service forks the node processes for you. BaseClusterPort and BaseClientPort are required; BaseClientPort is the port your application connects to:

# Create the store (supervisor mode forks the node processes).
# BaseClusterPort/BaseClientPort are REQUIRED. BaseClientPort is what your app connects to.
New-ZrStore -Name orders -ReplicationFactor 2 `
  -BaseClusterPort 7811 -BaseClientPort 7861

The backtick (`) at the end of the first line is PowerShell line-continuation.

tip

You can do the same in the Web Console at http://localhost:7810. Add the Management Service in the UI and create the store from there — no cmdlets needed.

4. Connect​

Connect a client to the store on its client port:

zaris://localhost:7861/orders

What you just did​

You installed Zaris on Windows, activated a workspace against the local Management Service, created a store, and connected to it. From here you can operate the store from PowerShell or the Web Console, or connect to it from your .NET applications.

Next steps​