The FiveM Server Handbook
setup to launch, in one place.

#How a FiveM server works

A FiveM server is FXServer — the Cfx.re server program — running a folder of resources and a server.cfg. Knowing which part does what makes every later chapter easier.

#Hardware and hosting

The FXServer main thread does most of its work on one core, so the speed of a single CPU core matters more than the number of cores. Choose hardware and a host around that.

#Installing FXServer and txAdmin

The official quick route is txAdmin: download the artifacts, run them, and txAdmin sets up the rest in your browser. The vanilla route — cfx-server-data plus your own server.cfg — still works and shows what txAdmin does for you.

Add-MpPreference -ExclusionPath 'C:\FXServer\'

sudo apt install -y xz-utils curl git
mkdir -p ~/FXServer/server && cd ~/FXServer/server
wget "<recommended fx.tar.xz URL from the Server Download page>"
tar xf fx.tar.xz
./run.sh    # starts txAdmin on port 40120

git clone https://github.com/citizenfx/cfx-server-data.git ~/FXServer/server-data
cd ~/FXServer/server-data
# create server.cfg (see the next chapter), then:
bash ~/FXServer/server/run.sh +exec server.cfg

#server.cfg, line by line

server.cfg is a list of console commands run at startup. Endpoints and convars go first, resources start in dependency order, and secrets live in a separate file.

# Network: players connect on 30120, TCP and UDP
endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"

# How the server appears in the server list
sv_hostname "Night City RP"
sets sv_projectName "Night City RP"
sets sv_projectDesc "Serious roleplay with custom jobs, housing and a player-run economy."
sets tags "roleplay, serious, economy, jobs"
sets locale "en-US"
load_server_icon logo96.png
sets banner_detail "https://example.com/banner-detail.png"
sets banner_connecting "https://example.com/banner-connecting.png"

# Game settings (startup only)
set onesync on
sv_maxclients 48
sv_enforceGameBuild 3258

# Security basics (see the Security chapter)
sv_scriptHookAllowed 0
sv_endpointPrivacy true
sv_pureLevel 1

# Database for oxmysql
set mysql_connection_string "mysql://fivem:[email protected]/fivem?charset=utf8mb4"

# Base resources, then libraries, then framework, then everything else
ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure hardcap
ensure oxmysql
ensure ox_lib
ensure [framework]
ensure [jobs]
ensure [maps]
ensure [ui]

# Permissions
add_ace group.admin command allow
add_ace group.admin command.quit deny
add_principal identifier.fivem:1 group.admin

# Keys and tokens live in a file you never share
exec secrets.cfg

sv_licenseKey "your-server-key"
set steam_webApiKey ""
set discord_bot_token "..."

#Ports, firewall and connecting

When players cannot connect, or the server is missing from the list, the cause is almost always ports, the firewall or two missing convars.

sudo ufw allow 30120/tcp
sudo ufw allow 30120/udp
sudo ufw allow from YOUR.HOME.IP to any port 40120 proto tcp
sudo ufw allow OpenSSH
sudo ufw enable

New-NetFirewallRule -DisplayName "FiveM TCP" -Direction Inbound -Protocol TCP -LocalPort 30120 -Action Allow
New-NetFirewallRule -DisplayName "FiveM UDP" -Direction Inbound -Protocol UDP -LocalPort 30120 -Action Allow

#Resources, fxmanifest.lua and start order

Every feature on a FiveM server is a resource: a folder with an fxmanifest.lua. Organised folders and a clear start order prevent most “it worked yesterday” problems.

resources/
  [base]/        mapmanager, chat, spawnmanager, sessionmanager, hardcap
  [libs]/        oxmysql, ox_lib, ox_target
  [framework]/   qbx_core or es_extended and its core resources
  [jobs]/        police, ambulance, mechanic
  [maps]/        MLOs and ymaps
  [vehicles]/    add-on cars
  [ui]/          hud, loading screen, minimap

fx_version 'cerulean'
game 'gta5'
lua54 'yes'

name 'nc_garage'
version '1.2.0'

shared_scripts { '@ox_lib/init.lua', 'config.lua' }
client_scripts { 'client/*.lua' }
server_scripts { '@oxmysql/lib/MySQL.lua', 'server/*.lua' }

ui_page 'web/dist/index.html'
files { 'web/dist/**' }

dependencies { 'oxmysql', 'ox_lib' }

#Database: MariaDB and oxmysql

Frameworks keep players, money, items and vehicles in MariaDB (or MySQL) through oxmysql. The database is the most valuable thing on the machine — set it up properly and back it up from the first day.

sudo apt install -y mariadb-server
sudo mariadb-secure-installation
sudo mariadb

CREATE DATABASE fivem CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'fivem'@'127.0.0.1' IDENTIFIED BY 'a-long-random-password';
GRANT ALL PRIVILEGES ON fivem.* TO 'fivem'@'127.0.0.1';
FLUSH PRIVILEGES;

set mysql_connection_string "mysql://fivem:[email protected]/fivem?charset=utf8mb4"
set mysql_slow_query_warning 200
ensure oxmysql

#Frameworks and the core stack

A framework gives every script the same idea of a character, a job, money and an inventory. Choose one before you buy scripts — most resources are written for a specific framework.

#OneSync, player slots and game builds

OneSync makes the server aware of every entity. It is required for large slot counts and unlocks server-side entity natives, entity lockdown, state bags and routing buckets.

-- move a player into their apartment instance
SetPlayerRoutingBucket(source, 1000 + source)
SetRoutingBucketPopulationEnabled(1000 + source, false)

-- back to the normal world
SetPlayerRoutingBucket(source, 0)

-- synced data on the player
Player(source).state:set('duty', true, true)

#Streaming maps, MLOs, vehicles and clothing

Anything that adds or replaces game content — maps, MLOs, vehicles, clothing, props, the minimap — is streamed: the files sit in a resource’s stream/ folder and players download them on join.

fx_version 'cerulean'
game 'gta5'

files {
    'data/vehicles.meta',
    'data/handling.meta',
    'data/carvariations.meta',
    'data/carcols.meta',
}

data_file 'HANDLING_FILE' 'data/handling.meta'
data_file 'VEHICLE_METADATA_FILE' 'data/vehicles.meta'
data_file 'CARCOLS_FILE' 'data/carcols.meta'
data_file 'VEHICLE_VARIATION_FILE' 'data/carvariations.meta'

#Performance: server lag, FPS and texture loss

Measure before you change anything. Server lag, client FPS drops and texture loss have different causes and different tools.

profiler record 500
profiler view

#Security hardening

FiveM security comes down to two things: server convars that shut whole classes of abuse, and scripts that never trust the client.

#Admins, ACE permissions and moderation

Two permission systems run side by side: txAdmin permissions for the web panel and in-game admin menu, and ACE permissions for commands and scripts.

# groups
add_ace group.admin command allow
add_ace group.admin command.quit deny
add_ace group.mod command.kick allow
add_principal group.admin group.mod

# people
add_principal identifier.fivem:1 group.admin
add_principal identifier.discord:123456789012345678 group.mod

# check from the console
test_ace group.mod command.kick

RegisterCommand('kickidle', function(source)
    if source ~= 0 and not IsPlayerAceAllowed(source, 'command.kick') then return end
    -- ...
end, false)

#Restarts, backups and updates

Stable servers are boring on purpose: fixed restart times, automatic backups, a test server for updates and a written rollback plan.

AddEventHandler('txAdmin:events:scheduledRestart', function(data)
    if data.secondsRemaining == 60 then
        -- save everything that is not saved yet
    end
end)

AddEventHandler('txAdmin:events:serverShuttingDown', function()
    -- final save
end)

#!/bin/sh
STAMP=$(date +%F-%H%M)
mariadb-dump --single-transaction fivem | gzip > /backups/fivem-$STAMP.sql.gz
tar --exclude='server-data/cache' -czf /backups/server-data-$STAMP.tar.gz -C /home/fivem server-data
find /backups -type f -mtime +14 -delete

#Map, minimap and world settings

The map is what players look at most. Minimap, blips, weather, traffic, wanted level and interiors are all yours to configure.

CreateThread(function()
    SetMaxWantedLevel(0)
    for i = 1, 15 do
        EnableDispatchService(i, false)
    end
    SetCreateRandomCops(false)
end)

#Troubleshooting common problems

Most server problems follow a handful of patterns. Find the symptom, check the likely cause, then open the linked guide.

#The launch checklist

Before you advertise anywhere, go through this list. Every item is something a real server discovered on launch day.

Cheat sheets

The commands, convars and paths you will look up again and again.

Glossary

Every term this handbook uses, in one line each.

ACE

Access Control Entry — a permission rule added with add_ace, checked with IsPlayerAceAllowed.

Artifacts

The FXServer builds Cfx.re publishes; “recommended” for live servers, “latest” for testing.

Cfx.re

The company and platform behind FiveM and RedM, now part of Rockstar Games.

Cfx.re Portal

portal.cfx.re — where you create server keys and manage subscriptions; replaced Keymaster.

Convar

A console variable such as sv_maxclients, set with set, sets or setr.

Deferrals

The playerConnecting API for holding a connecting player: checks, messages, adaptive cards.

Element Club

Cfx.re subscriptions; Argentum or higher unlocks more than 48 slots.

Entity lockdown

sv_entityLockdown — controls whether clients may create entities.

ESX

A long-running roleplay framework (es_extended).

fxmanifest.lua

The manifest every resource needs: scripts, files, dependencies, data files.

FXServer

The server program that runs FiveM and RedM servers.

Game build

The GTA V update a server enforces with sv_enforceGameBuild.

Hitch warning

A console warning that the server thread was blocked for a number of milliseconds.

Identifier

A player ID such as license:…, discord:… or fivem:….

IPL

A named map chunk switched on with RequestIpl, often used for interiors.

MLO

A custom interior streamed as a map resource.

Native

A game or Cfx.re function callable from scripts, listed at docs.fivem.net/natives.

NUI

The in-game browser layer used for HUDs, menus and loading screens.

OneSync

Server-side state awareness; required above 64 slots.

oxmysql

The standard MySQL/MariaDB connector resource for FiveM.

ox_lib

A shared library of UI, callbacks, zones and helpers used by many resources.

Pool

A fixed-size game store (textures, objects…) that can be raised with increase_pool_size.

Principal

A group or player identity that ACE rules apply to, such as group.admin.

Qbox

A QBCore-compatible framework built on the ox stack (qbx_core).

QBCore

A popular roleplay framework (qb-core).

Recipe

A txAdmin template that deploys a complete server.

resmon

The in-game resource monitor (F8 → resmon 1) showing CPU time and memory per resource.

Resource

A folder with an fxmanifest.lua — one feature, map, vehicle or UI.

Routing bucket

A separate instance of the world; bucket 0 is the normal world.

server.cfg

The startup config: endpoints, convars, resources and permissions.

State bag

Synced key/value data attached to players, entities or the global state.

Stream folder

A resource’s stream/ folder; files there are sent to clients as game assets.

sv_pureLevel

Blocks modified client game files at level 1 or 2.

txAdmin

The web panel bundled with FXServer for setup, restarts, players and bans.

txData

txAdmin’s data folder: admins, bans, settings and history.

YDD

Drawable dictionary — clothing, peds and minimap geometry.

YDR

A single drawable model, such as a prop or weapon.

YFT

A fragment model, mainly vehicles.

YMAP

A placement file listing entities in the world.

YTD

A texture dictionary.

YTYP

Archetype definitions for new props and interiors.

Questions server owners ask

Official references

Primary sources this handbook is checked against. When in doubt, they win.