Skip to content
Xenvious.DevelopmentDocs

Explore the documentation

Banner Apartments / GuideBanner ApartmentsSet up temporary character rooms, personal storage, and saved outfits in Riot's Banner Hotel.Raids / GuideRaid SystemSet up configurable guard encounters, a recoverable objective, and a delivery reward for your FiveM server.Evidence / GuideEvidence SystemConfigure scene evidence, forensic tools, persistent lockers, lab analysis, and chain of custody on a Qbox server.XenLogs / GuideXenLogsInstall XenLogs, connect your FiveM server, and give your team a clearer view of what happens in game.
↑ ↓ to navigateEnter to openSearch all guides
XENLOGS / DOCUMENTATION5 min read

Install XenLogs

From download to your first connection, with the exact resource name and server.cfg settings.

On this page

Check the requirements

  • An FXServer build that supports node_version '22'. The resource selects that runtime in its manifest.
  • Access to your resources directory, server.cfg, and the server console.
  • An active XenLogs subscription and a community you own or can configure.
  • Outbound connectivity from FXServer to https://logs.xenvious.dev, including secure WebSocket connections.

The distributed resource includes its server bundle and panel assets. You do not need to install npm packages on your game server. ESX and QBCore are optional integrations, not prerequisites for custom logging.

1. Create a server and save its key

  1. Open the XenLogs dashboard and sign in.
  2. Create a community if you do not have one, or select the community that will own this server.
  3. Choose Add Server on the Overview page and enter a recognizable server name.
  4. Copy the API key shown after creation and store it securely for the next step.
Open the Overview page

Create your community and server.

Open page

2. Download and extract the resource

Download XenLogs.zip from the Download page. Extract the included XenLogs folder into your FiveM resources directory. Keep the folder name exactly as shipped, including the capital X and L.

Resource folder
resources/
└── XenLogs/
    ├── fxmanifest.lua
    ├── server.js
    └── panel/
        ├── xenlog-panel.js
        └── xenlog-panel.css

The manifest must be directly inside resources/XenLogs/. An extra nested XenLogs folder prevents FXServer from finding the resource correctly.

Download XenLogs

Requires an owner account or Manage Config permission.

Open page

3. Update server.cfg

Add these lines to server.cfg, replace the placeholder with this server's API key, and save the file. Start XenLogs before any custom resources that call its exports.

server.cfg
set xenlog_apikey "YOUR_SERVER_API_KEY"
add_unsafe_child_process_permission XenLogs
ensure XenLogs

Restart FXServer after saving. Changing server.cfg on disk alone does not update a running resource's configuration.

4. Verify the connection

  1. Check the server console for the XenLogs startup banner and Connected to gateway (socket.io).
  2. Open the dashboard and confirm you selected the server whose API key you installed.
  3. In Settings, enable the ESX or QBCore integration that matches your server and save the change.
  4. Trigger a supported event, or use the test resource in Custom events, then open Logs to check the result.
Server console
xenlog status
xenlog rescan

xenlog status prints the resource version, batching settings, and integration toggles. xenlog rescan refreshes the list of running resources. These commands run from the server console; status output alone does not prove logs reached the dashboard.

Enable framework events

Choose ESX or QBCore and understand event coverage.

Read guide Connection troubleshooting

Resolve missing keys, offline servers, and empty log views.

Read guide