Print Friendly
Comments

Installation Guide

Installation from the provided MSI packages should appear completely familiar. Administrative privilege is required. Microsoft's .NET Framework 4 (or 4.5/4.6) is a prerequisite.

Service & Interface Instances

The program operates in two modes;

1. As a service which starts immediately after installation and whenever the host machine is rebooted. This instance schedules and executes the monitoring tasks (which run with or without a user logged-on).

2. As a desktop application when launched in a user-interactive session. This instance facilitates configuration of the service and its tasks. By default an interface instance will connect to the local service immediately on starting.

Interface Binding

The service communicates with a single interface instance (the most recently connected) via TCP/IP. A newly installed service accepts connections only on the loopback adapter (127.0.0.1) but it's possible to alter this (in Options > Service) such that it may be managed and monitored from a different machine. This might permit an on-site staff member to receive tray notifications for alerts via a suitably configured install on their own workstation.

Interface connections are not authenticated or encrypted so it's important to ensure access is only available to trusted machines. It might be necessary to revise the scope of the firewall rule created by the Winserver Wingman installer before enabling this.

Unattended & Silent Installs

The packages support standard MSIEXEC switches for passive installation;

msiexec /qn /i "C:\Users\Console\Downloads\WingmanSetup64.msi"

And also uninstalls (via the MSI Product Code);

32-Bit: msiexec /qn /x {2407DD18-E662-41DD-8FA2-09B7C89D1949}

64-Bit: msiexec /qn /x {C7BD4CE3-3309-4434-86E4-6CC66E03E6F2}

Monitoring tasks and online reporting parameters may be preconfigured by merging a registry file exported from another installation (in Options > Service). The settings should be merged prior to installation so they're available when the monitoring service first starts (a restart will otherwise be required).

Installer Information

An installation may be branded with a company logo and/or contact details. These appear in the About tab and should inform an end-user who initially configured the monitoring.

Replace one or both of the files; Installer.logo (with a 176x64 BMP image) and Installer.info (a plain TXT file up to 7 lines of which will be displayed). The two elements overlap and the text file should incorporate empty lines to control relative vertical placement.

Example 'Installed By' Graphic & Contact Details

Restricting Access on Multi-User Systems

Where installed on a machine that routinely hosts end-users (i.e. in a Remote Desktop Services role) it's probably desirable to limit access to the interface to guard against tampering with the monitoring tasks. Safeguards described under Task Security for the Check a Console Command task limit the potential harm from such mischief to a nuisance only but it's recommended nonetheless.

One simple mechanism would be to flag Wingman.exe as requiring elevation to run for all users via the Compatibility tab of the file properties dialog;

Multiple Service Instances

If there's a need to have a single machine post notifications under more than one online reporting account additional service instances will be required, each configured with the alternate account particulars. New service instances may be registered using the Windows command line Service Controller (sc.exe). Each will require a unique service name comprising "WingmanService" suffixed with an instance ID which is also passed to the service on start-up;

sc create "WingmanServiceXXX" binpath= "\"C:\Program Files\Winserver Wingman\Wingman.exe\" XXX" start= "auto" depend= "TCPIP/DNSCache/RPCSS" displayname= "Winserver Wingman (Triple X)"

The instance ID determines the log file name and the registry location for its configuration;

HKEY_LOCAL_MACHINE\SOFTWARE\Ionwerks\WingmanXXX

This location will need to contain explicitly configured values for;

  • MachineID (REG_QWORD): A numeric ID, unique within the organization.
  • ServiceHost (REG_SZ): The IP:Port an interface should connect to the service on.

Simplest to download, edit and run ('as Administrator') the batch file linked below;

Service Registration Batch File

22 August 2016