Skip to main content

Install on Windows

Requirements

  • Windows 10, Windows 11, Windows Server 2016, 2019, or 2022, x64.
  • Administrator privileges.
  • 4 GB RAM minimum; 8 GB recommended with bundled Kafka.
  • 2 GB free disk minimum; 4 GB with bundled Kafka.

The installer supplies the Linkiir application dependencies. A bundled-Kafka installation also includes Java and Kafka.

Interactive installation

  1. Run LinkiirSetup-1.0.0-x64.exe as Administrator.
  2. Accept the approved software terms.
  3. Select the installation directory, normally C:\Program Files\Linkiir.
  4. Choose a queue mode:
    • Install Apache Kafka for me for a self-contained DEV/TEST installation.
    • Connect to my own Kafka or Redpanda broker for an existing cluster.
  5. For an external broker, enter the endpoint, security protocol, SASL settings, and CA certificate when applicable.
  6. Run Test Connection.
  7. Review the summary and install.

The installer waits for the broker and GET /api/health before presenting the completion page.

Silent installation

Bundled Kafka:

LinkiirSetup-1.0.0-x64.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART

External broker:

LinkiirSetup-1.0.0-x64.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART `
/QueueMode=external `
/BootstrapServers="broker1.example.com:9093,broker2.example.com:9093" `
/SecurityProtocol=SASL_SSL `
/SaslMechanism=SCRAM-SHA-512 `
/Username=linkiir_svc `
/SaslPasswordEncrypted="<encrypted-token>" `
/CaCertificate="C:\certs\corp-ca.pem"

Installed services and data

ItemDefault
Grid serviceLinkiirGrid
Bundled queue serviceLinkiirKafka
Program filesC:\Program Files\Linkiir
Mutable configuration/dataC:\ProgramData\Linkiir
Studiohttp://127.0.0.1:8080
Runtime gRPC127.0.0.1:50051
Kafka127.0.0.1:9092

The Grid supervises Runtime and Log Archiver child processes. They do not normally appear as separate Windows services.

Verify

Get-Service LinkiirGrid, LinkiirKafka
Get-Content "C:\ProgramData\Linkiir\logs\installer\readiness.txt"

READY means the installation completed and the services answered readiness checks.