FeaturesPricingDocsAboutSupport

Docs / FiveM

FiveM Integration

One resource install connects your whole server to Docket: whitelist, in-game bans, player linking, live status, remote commands and playtime — with no open ports and nothing else to host.

Requirements

  • An active Docket Pro plan or higher
  • A FiveM server with txAdmin or direct file access
  • Any framework — QB-Core, ESX, vMenu or fully custom. The resource hooks at connection level, so it does not touch gameplay systems.

Install (once, ~3 minutes)

  1. Go to Dashboard > Integrations and click Generate API key — copy it, it is shown once
  2. Click Download resource and drop the docket_whitelist folder into your server's resources directory
  3. Add to server.cfg and restart:
ensure docket_whitelist
set docket_api_key "YOUR_KEY_FROM_THE_INTEGRATIONS_PAGE"
set docket_whitelist_mode "1"   # 1 = whitelisted players only, 0 = open joins (bans still enforced)
set docket_fail_open "0"        # if Docket is unreachable: 0 = deny joins, 1 = allow joins

Within a minute the Integrations page shows Live, and Members → FiveM lights up with your server.

What that one install does

CapabilityHow it works
WhitelistApproval in Docket IS the whitelist — players without an approved application are turned away at connect with a friendly message. Optional via docket_whitelist_mode.
In-game bansAn active Docket ban (or unexpired timeout) blocks the player at connect, with the reason shown. Punished in Discord = punished in-game.
Player linkingEvery player is matched to their Discord automatically the moment they join — no verification steps for members.
Live statusThe resource pushes server status and the full player list to Docket every 60 seconds. No ports exposed, players.json can stay firewalled.
Remote actionsAnnouncements, kicks and console commands queued from the dashboard execute in-game within ~15 seconds.
PlaytimeHours per player accumulate from the heartbeats — leaderboard on the roster, and automatic playtime role binds.
Down alertsIf your server stops reporting for 5 minutes, Docket posts an alert to your audit channel — and an all-clear when it returns.

Automated roles

  • Player role — a Discord role granted the first time someone joins your server (Integrations → Automated player role)
  • Playtime binds — "10 hours → Regular, 50 hours → Veteran" — configured on Integrations, granted automatically every 15 minutes

Members can check their own link with /link me; staff can look anyone up with /link lookup.

Failure behaviour

  • Joins never wait on Docket for more than 10 seconds — docket_fail_open decides what happens if Docket is unreachable
  • The whitelist cache pre-warms at startup and refreshes every 5 minutes, so most joins never touch the network
  • Remote commands not picked up within 10 minutes expire instead of executing late
← Bot CommandsQB-Core Setup →