Documentation

Step 1 — Create a Server Key

Go to the Server Keys tab in your dashboard (or click Add Server from the Servers tab). Generate a new key — this opens the setup guide which contains your download links and the exact server.cfg snippet to copy.

Step 2 — Download & run the Veil Agent

The agent is a single binary that runs on your game server host (not inside FiveM). The download link for your OS is in the setup guide. Place it anywhere on your host and run it.

The agent reads its configuration from the set vm_* values in your server.cfg — no separate config file to fill in. It auto-updates itself on startup so you never need to re-download it.

Step 3 — Install veil-monitor (Lua resource)

This is the in-game FiveM resource that enables anti-cheat, player sessions, economy monitoring, and live spectate. Download it free from our Tebex store. It comes pre-encrypted via FiveM escrow.

1. 1

   Extract to your resources folder

   resources/[veil]/veil-monitor
2. 2

   Add to server.cfg — copy from the setup guide

   ensure veil-monitor

Step 4 — Restart & verify

Restart your FiveM server. Watch the console for these lines:

If you don't see these, check the Troubleshooting section.

Adding your first server

1. 1 Go to the Servers tab and click Add Server, or go directly to Server Keys.
2. 2 Give the server a name and generate a Server Key. This opens the setup guide.
3. 3 Follow the setup guide — it gives you the download link for the agent and the exact server.cfg block to copy.
4. 4 Add the cfg block to your server.cfg, place the agent binary on your host, and start both.
5. 5 Once veil-monitor sends its first heartbeat, your server's IP and port are registered automatically. No manual entry needed.

Server settings

Team members

You can invite staff to your server under Settings → Team. Each member can be assigned a role:

Sending commands

Type any command in the input bar at the bottom and press Enter or click Send. Commands are sent via RCON to your server. Examples:

Server controls

⚠️ These controls work only if the Veil Agent is managing your FXServer process. If you start FXServer yourself independently, Start/Stop/Restart will not work.

Filtering & search

• • Use the filter bar to filter by severity: Info, Warning, Error, Success.
• • Use the component dropdown to filter by resource name (e.g. only show script:veil-monitor).
• • Use the search box to full-text search across all visible lines.
• • Ctrl+K clears the console. ↑↓ arrows cycle command history.

System metrics

Collected every 5 minutes (configurable) and displayed as real-time charts on the server dashboard. Includes CPU usage, RAM usage/total, player count, and uptime.

Per-resource performance breakdown

Found under the Performance tab. The agent profiles FXServer every few minutes and breaks down exactly how long each Lua resource is taking per tick.

Alerts

When a resource exceeds the configured duration threshold (default: 2ms), an alert is recorded and appears in the Performance tab sidebar. You can acknowledge alerts directly from the dashboard. Configure thresholds under Settings → Alerts → Resource.

Online players

The Players tab shows all currently connected players with their name, license identifier, IP, job, gang, and current coordinates. Click any player to open their full profile.

Player profile

Each player has a profile page showing their history, identifiers, and current status. From here you can:

Ban management

All bans are listed under the Bans tab. You can search by name, license, or IP. To unban a player, click their entry and select Unban. Bans are enforced by the veil-monitor resource on connect.

Offline player lookup

Can't find a player because they're not online? Use the search on the Players page — it searches the database for players who have connected before, even if they're currently offline.

Detection types

Auto-ban

When a detection fires, the player is immediately kicked and the event is logged to the dashboard. If the same player triggers multiple detections, they are automatically banned. All detections appear in the Activity feed on the server dashboard.

Starting a spectate session

1. 1 Go to Players and find the player you want to spectate.
2. 2 Click their name to open their profile, then click Spectate.
3. 3 The spectate page opens. The stream initializes automatically — wait a moment for the first keyframe to arrive.
4. 4 Use Reconnect if the stream drops, or Stop to end the session.

Framework support

Set your framework under Settings → General → Framework. Data is collected passively as players log in and out — no script modifications required for ESX, QBCore, or QBox.

Setup

1. 1 Go to Dashboard → your server → Discord.
2. 2 Click Link Guild and authenticate with your Discord account.
3. 3 Select the Discord server (guild) to link.
4. 4 Optionally set an alert channel for performance/cheat notifications.
5. 5 Configure command permissions — assign which Discord roles can run each command.

Available commands

Creating a backup

Go to your server → Backups → Create Backup. The agent connects to your database using the credentials in its config and creates a compressed SQL dump. The backup file is stored on your game server host.

Restoring a backup

Select a backup from the list and click Restore. The agent will apply the SQL dump to your database. ⚠️ This overwrites current data — make sure you have a recent backup before restoring.