Skip to content
BasiX Media

server.cfg convars

A copy-pasteable config block.

On this page
ConvarDefaultMeaning
basix_keynoneRequired. Must start with bx_live_.
basix_folderemptyPrefix for every upload, for example myserver.
basix_datasetdefaultDataset for logs.
basix_log_levelinfoMinimum level sent: trace, debug, info, warn, error, fatal.
basix_sitestrueAllow connected players on player-only sites. false turns it off.
basix_endpointhttps://upload.basix.mediaFor testing only.

Warning

Never commit server.cfg with a real key, and never put basix_key in a client-side script. Keep it in server.cfg or in a secret manager your host supports — the resource reads it with GetConvar, server-side only.

Copy-paste block, with every convar this page covers:

server.cfg
set basix_key "bx_live_yourkeyhere"
set basix_folder "myserver"
set basix_dataset "economy"
set basix_log_level "info"
set basix_sites "true"
ensure basix

Drop basix_folder, basix_dataset, basix_log_level and basix_sites if the defaults are fine — only basix_key and ensure basix are required.

Depending on basix from your own resource

If a resource of yours calls exports.basix:..., declare the dependency in its fxmanifest.lua so FXServer refuses to start it without basix:

fxmanifest.lua
fx_version 'cerulean'
game 'gta5'

name 'my-resource'
author 'you'
version '1.0.0'

dependency 'basix'

server_script 'server.lua'

Try it on your own server

Create a free account and your API key is ready in about two minutes. 3 GB included, bandwidth never billed, no card needed.

Create a free account
server.cfg convars — FiveM docs — BasiX