Sync
Site Runner Setup
Site Runners are an optional component that allow AB Tutor to interface with your local network.
Site Runner currently allows support for Wake on LAN (WoL) which lets you remotely wake computers from sleep or hibernation. With more features related to the Site Runner in future releases.
We recommend installing Site Runner on a machine that is always powered on and connected to your local network during normal operations.
Where possible, we suggest having One Site Runner per site.
Add a new Site Runner
- Navigate to the Sites section and select the Site Runners tab.
- Click Set up a Site Runner.
- You will be asked to provide a name for the runner and select the site it belongs to.
This will generate and are required during installation:
- The tenant key
- The site ID
- A long lived authentication token
- Select Download the runner to download the installer.
- During installation, enter the tenant key, site ID, and runner authentication token.
Once installed, the Site Runner:
- Registers itself as a Windows service
- Starts automatically with Windows
- Reports availability back to AB Tutor Cloud
Set up Active Directory User Authentication
For AB Tutor to authenticate Active Directory Users so that they will appear inside the Console UI you will need to follow the following steps:
- Create a gMSA Service account.
You will need to provide the Computer Account name where the site runner will be installed, or a security group containing the Computer. An example of this can be found below:
New-ADServiceAccount -Name runnerName -DNSHostName runnerName.domain -PrincipalsAllowedToRetrieveManagedPassword "security Group Name"
- Grant this new account the ability to log in as a Service
$account="domain\runnerName$"; $cfg="$env:TEMP\secpol.cfg"; secedit /export /cfg $cfg >$null; (Get-Content $cfg) -replace '^(SeServiceLogonRight\s*=\s*)(.*)$', { if ($_.Groups[2].Value -match [regex]::Escape($account)) { $_.Value } else { "$($_.Groups[1].Value)$($_.Groups[2].Value -replace '\s+$',''),$account" } } | Set-Content $cfg; secedit /configure /db "$env:TEMP\secedit.sdb" /cfg $cfg /areas USER_RIGHTS >$null; Remove-Item $cfg -Force
- Install the site runner on a Domain joined Device and supply the gMSA in the format
domain\runnerName$during the installation.
Troubleshooting
The site runner has no direct user interface but will write logs to:
:\ProgramData\ABTutor\v10\siterunner\logs```
Critical issues are written to the **Windows Event Log**.
### Test Active Directory User Authentication
Log in to the Site runner device as the account you have set up. Then run the following command:
> nltest /dsgetdc:<your-domain>.com
This will allow you to test your connectivity to the domain.
### Wake On LAN Troubleshooting
Wake on LAN must be supported and enabled in the network configuration of the target device.
- ***Restart*** your computer and enter the **BIOS/UEFI settings**
- The location can differ so look for Power Management/Network adapter configuration/Advanced Menu
- Look for similar terms like **Wake on LAN**
*Note:* Wake on LAN typically requires a **wired ethernet connection**.
To facilitate Wake On LAN, devices connected to AB Tutor will report their **MAC address** at regular intervals.
If this configuration changes, it may take up to 24 hours for the runner to use the updated MAC address for that device.
Restarting the target device and the site runner service will force this information to be **re-reported** and **reacquired**.
To determine whether network configuration is correct. Tools like https://wol.aquilatech.com can be helpful to **diagnose** Wake on LAN network issues.
## Adjusting Wake On LAN behaviour
This section describes ways to adjust the runner's WoL packet-sending behaviour.
For most sites, the default settings should be appropriate, but some network setups may require additional configuration for better results.
For details on using Wake on LAN and setting up schedules, see: [Wake On LAN](consoleUI/wakeOnLan.md).
### Registry Settings
The Site Runner's WoL (Wake on LAN) packet sending behaviour can be configured via the registry under
HKEY_LOCAL_MACHINE\SOFTWARE\ABTutor
The following settings are currently supported:
| Registry Value | Type | Description |
| ------------------------ | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| WolBroadcastPorts | String | Comma-separated list of ports to send WoL packets to. Default: 7,9 |
| WolAlwaysLocalBroadcast | DWORD | If set to 1, always attempts to perform a local broadcast even if the target device does not appear to be in the same subnet. |
| WolSkipDirectedBroadcast | DWORD | If set to 1, skip attempts at directed cross-subnet broadcasts to reduce packet noise if network conditions make this unnecessary or ineffectual. |
| WolInterfaceOverrideGuid | String | Network interface GUID to use for sending WoL packets. If not found or empty, falls back to automatic selection. Find with Powershell: `Get-NetAdapter \| Select-Object Name, InterfaceGuid` |
| WolRateLimit | DWORD | Max number of WoL packets to send per second. Default: 100 |
### Subnet Broadcast Configuration
The runner by default will automatically derive a subnet's broadcast address. This is sufficient for most networks.
If your network **does not support cross-subnet directed broadcasts**, you still need to perform cross‑subnet Wake on LAN, you can define manual broadcast relay addresses.
You can then describe this mapping in a configuration file called *broadcast-mapping.txt*
Place it inside the Site Runner installation directory.
Each line should contain a CIDR block followed by a comma followed by the relay address
Example:
192.168.1.0/24,10.255.255.255
172.16.0.0/16,192.168.255.255
This will instruct the runner to send WoL packets to the given relay address for any target address that falls within the specified CIDR block.
**Important:**
- You will need to restart the runner service after updating the broadcast mapping file.
If creating relay addresses is not an option, you may need to set up additional site runners in the broadcast domains you need to reach.
Updated on: 11/05/2026
Thank you!