VOIDSHIELD DOCS

Deploy. Integrate. Protect.

Quick-start documentation for installing the resource, connecting the control plane and protecting sensitive ESX/QBCore actions with server-side policy checks.

1. Install the FiveM resource

Place the licensed voidshield resource in your server resources directory and ensure it after your framework dependencies.

ensure oxmysql
ensure es_extended   # or qb-core
ensure voidshield

2. Connect the control plane

Your customer portal provides the license key and API endpoint used by the FiveM resource.

setr voidshield:license "YOUR_LICENSE_KEY"
setr voidshield:api "https://control.yourdomain.com"
ensure voidshield
ESXQBCoreOneSync

3. Protect sensitive events

Call the policy engine from the server resource that owns the sensitive action. Only execute the money, inventory, vehicle, weapon or reward change after the check returns allowed.

local allowed, reason = exports.voidshield:CheckPolicy(source, 'jobPayout', {
  amount = serverCalculatedAmount
}, {
  jobs = { mechanic = true },
  maxAmount = 2500,
  cooldownMs = 3000
})

if not allowed then return end
-- Execute server-owned action here.

4. Evidence and correlation

Detection evidence can be ingested by the control plane, retained in private object storage and correlated with other events into a reviewable security case.

5. Customer API

Create scoped API keys from the dashboard for telemetry, server status, detections, incidents or evidence integrations.

Authorization: Bearer vs_live_...
GET /api/v1/servers
GET /api/v1/detections
GET /api/v1/incidents
GET /api/v1/evidence

6. Signed updates

The updater verifies the Ed25519 signature, SHA-256 digest and file size before staging a new release. Automatic apply can remain disabled until you approve it in production.