Windows Backup Agent

The Windows backup agent is a background task installed on the server machine. It handles work that should not run inside FXServer.

What It Does

The agent handles:

• Config, resources, full-server, and database backups
• Lua security scans
• Inventory audits
• Image optimisation
• items.lua cleanup
• Job polling from FiveOps
• Auto-updates

Install

Copy fiveops-backup-agent onto the Windows server, preferably beside server.cfg.

Example:

server-data/fiveops-backup-agent

Double-click:

install-fiveops-backup-agent.cmd

If the config does not exist, the installer creates it and opens Notepad.

Config

Edit:

fiveops-backup-agent.config.json

Minimum required values:

{
  "apiBaseUrl": "https://five-ops.vercel.app",
  "communityId": "your-community-id",
  "connectorToken": "paste-generated-token-here"
}

Full config:

{
  "apiBaseUrl": "https://five-ops.vercel.app",
  "communityId": "PASTE_COMMUNITY_ID_HERE",
  "connectorToken": "PASTE_CONNECTOR_TOKEN_HERE",
  "serverName": "",
  "autoUpdate": true,
  "updateCheckIntervalMinutes": 5,
  "agentUpdateManifestUrl": "",
  "serverDataPath": "",
  "resourcesPath": "",
  "serverConfigPath": "",
  "backupOutputDirectory": "",
  "inventoryResourcePath": "",
  "inventoryItemsPath": "",
  "inventoryImagesPath": "",
  "inventoryBackupOutputDirectory": "",
  "inventoryImageMaxDimensionPx": 256,
  "inventoryImageMaxFileKb": 200,
  "inventoryJpegQuality": 85,
  "inventoryFindingUploadBatchSize": 100,
  "databaseDumpToolPath": "",
  "databaseHost": "127.0.0.1",
  "databasePort": 3306,
  "databaseName": "",
  "databaseUser": "",
  "databasePassword": "",
  "intervalSeconds": 30,
  "minimumFreeSpaceMb": 1024
}

Leave path fields blank for the normal server-data layout.

Start The Task

After saving the config, run the installer again:

install-fiveops-backup-agent.cmd

The installer creates a Windows Scheduled Task named:

FiveOps Backup Agent

Logs

Logs are written beside the agent:

fiveops-backup-agent.log
fiveops-inventory-optimisation.log
fiveops-lua-security-scan.log

Stop Or Remove

Stop the running task:

schtasks /End /TN "FiveOps Backup Agent"

Remove the task:

uninstall-fiveops-backup-agent.cmd

Auto-Update

When autoUpdate is true, the agent checks:

<apiBaseUrl>/downloads/fiveops-backup-agent/manifest.json

It verifies SHA-256 hashes, backs up replaced files under fiveops-agent-updates, and never overwrites fiveops-backup-agent.config.json.

By default it checks every 5 minutes. It also checks again before running queued backup, security scan, or inventory jobs so newly released helper scripts are picked up before work starts.

Some main-agent changes require restarting the scheduled task once after update.