Windows Agent installation

Install the Cygwin-based execution agent as an Administrator.

The Windows Agent mirrors the Linux command surface where practical while using the bundled GSP64 Cygwin runtime, Perl agent, batch launchers, and Task Scheduler startup.

Administrator requiredC:\GSP defaultCygwin GSP64 runtimeTCP 12679 default

Support boundary

Use the OS versions confirmed by repository evidence.

The installer package states Windows Server 2016 or later for server use and Windows 10/11 for testing. The bundled runtime guide focuses production operations on Windows Server 2019/2022.

Repository-supported targets

  • Windows Server 2019/2022 are the maintained runtime guide targets.
  • The installer README also lists Windows Server 2016 or later.
  • Windows 10/11 are listed for testing, not as the preferred production server target.

PowerShell baseline

The installer uses PowerShell and ScheduledTasks cmdlets, so Windows PowerShell 3.0 is the minimum management baseline. Microsoft documents Windows PowerShell 3.0 as released with Windows 8 and Windows Server 2012.

Microsoft's WMF table also shows WMF 3.0 availability for Windows 7 SP1 and Windows Server 2008 R2 SP1, but those operating systems are out of support and are not claimed as supported agent targets here.

Installer package

Run the batch wrapper from an elevated session.

The current installer wrapper checks Administrator privileges and launches the PowerShell installer with -NoProfile and -ExecutionPolicy Bypass.

Run install

Right-click Installer\install.bat
Select Run as Administrator

The PowerShell installer defaults to C:\GSP, clones the agent into C:\GSP\Agent, and writes logs under C:\GSP\logs.

Installer inputs

  • install path, default C:\GSP
  • Git repository URL and branch
  • agent listen IP and port
  • shared encryption key that must match the Panel remote-server record

What it creates

The installer creates Agent, home, tools\PortableGit, backups\agent, and logs. It extracts bundled Portable Git, clones the repository, creates runtime folders, configures the agent, and registers the GSP Windows Agent scheduled task as NT AUTHORITY\SYSTEM.

Runtime

The maintained launchers live under the bundled Cygwin root.

The Panel treats Windows and Linux agents as one product family, but Windows platform differences belong in the Windows agent layer.

Manual start

C:\GSP\Agent\GSP64\agent_start.bat

The launcher verifies bash.exe, creates default config files if missing, requires a Windows gameserver account, normalizes text files, validates gsp_agent.pl with Perl, stops stale PID processes, and launches the agent.

Manual stop

C:\GSP\Agent\GSP64\agent_stop.bat

The stop launcher reads known PID files and sends termination through bundled Cygwin tools.

Config files

Runtime configuration lives in C:\GSP\Agent\GSP64\GSP\Cfg. Keep Config.pm, Preferences.pm, and bash_prefs.cfg private and aligned with the Panel remote-server record.

Updates and rollback

Use the bundled maintenance wrappers for Git-managed installs.

These scripts are administrative tools. They preserve selected local folders and backups, but operators should still keep game server data and mutable customer files outside the Git-managed code boundary where possible.

Update

Installer\update.bat runs the PowerShell updater as Administrator. It stops the scheduled task, backs up the current agent, preserves selected folders, fetches Git, resets to origin/master by default, validates the agent when possible, and restarts the scheduled task.

Rollback

Installer\rollback.bat lists backups under C:\GSP\backups\agent, lets an admin select one, optionally preserves the current GSP64\GSP\Cfg folder, restores the backup, and starts the scheduled task.

Remove startup only

Installer\uninstall-task.bat removes the scheduled task only. It does not delete C:\GSP\home, game servers, backups, or the agent installation.

Panel handoff

Finish by connecting the Panel to the Windows Agent.

The agent must be reachable from the Panel and must use the same shared key configured on the Panel remote-server record.

Firewall

Allow the configured agent TCP port, normally 12679, from the Panel host. Also open game-specific ports for hosted servers.

Panel record

In the Panel, add the Windows host with its IP or hostname, listen port, encryption key, and shared key. Authentication failures usually mean the key in Config.pm does not match the Panel.

Logs

Check C:\GSP\logs\install.log for installer failures and C:\GSP\Agent\GSP64\GSP\gsp_agent.log for runtime agent output.