Installation

Requirements

• A recent FXServer with OneSync enabled (set onesync on, or the OneSync option in txAdmin). Without OneSync the server cannot see the entities, damage and positions the detections rely on.
• A supported framework or none: ESX, QBCore, Qbox, vRP, vRPex (creative) or standalone. See Frameworks.
• Nothing to install for players: SafeGuard downloads what the game needs by itself.

1. Download

Signed in to the dashboard, open Servers → Download SafeGuard and get the latest version. Packages are signed; do not use copies from elsewhere.

2. Copy to the server

Extract the safeguard folder into resources, for example:

resources/
  [safeguard]/
    safeguard/
      fxmanifest.lua
      config.lua
      SafeGuard.Server.net.dll
      ...

The folder must be called safeguard.

3. server.cfg

Add these lines after the framework (for example after ensure es_extended, ensure qb-core or ensure vrp) and before your other scripts:

# SafeGuard
set safeguard_cloud_url "https://api.safeguardac.online"
set safeguard_license_key "alk_xxxxxxxx.xxxxxxxx"
add_ace group.admin safeguard.admin allow     # sg commands and staff menu (F10)
add_ace group.admin safeguard.bypass allow    # staff are never scored or punished
ensure safeguard

Without the first two lines SafeGuard runs in local mode (no dashboard). You get the license key in the dashboard, under Licenses (see Dashboard).

4. Start and check

Restart the server (or refresh and ensure safeguard). The console should show:

[safeguard] INFO  started version=… framework=… cloud=Connected

Type sg status in the console to see the mode, players, detections and queue. If it says cloud=Rejected, the key is wrong or already in use on another machine (see Troubleshooting).

Updating

When a new version is out, the dashboard shows it on the server's page. Replace the safeguard folder keeping your config.lua and the data folder (local bans and offline queue), then restart safeguard.