QBCore Installation

The txAdmin recipe is the supported path and the one this page recommends. The manual route is documented for people adding QBCore to an existing server.

Prerequisites

Cfx.re account created and a server registration key created in the Cfx.re Portal
FXServer artifacts downloaded and extracted to a permanent path
MariaDB installed and running (not XAMPP, not MySQL 5.x)
Database and dedicated database user created
At least 10 GB free disk space for artifacts, resources and dumps

⚠️

Do not use XAMPP. It bundles an outdated MySQL, is not built for a long-running production workload, and is a recurring cause of data loss on FiveM servers. Install MariaDB directly.

Method 1 — txAdmin recipe

Start FXServer

Run FXServer.exe on Windows or run.sh on Linux. txAdmin opens its setup wizard in a browser tab.

Link your Cfx.re account

Choose the deployment type

Select Popular Recipes, then pick the QBCore recipe.

Set the resource path

Change the default to a dedicated folder. Moving it later means editing absolute paths in server.cfg and in txAdmin.

Enter database credentials

Give the deployer your MariaDB host, user and password. It creates the schema and imports the SQL for you.

Run the recipe and start the server

Wait for the deployer to finish, then start the server from the txAdmin dashboard.

Follow the official QBCore documentation and publisher-maintained txAdmin recipe for current framework-specific steps.

Method 2 — manual installation

Use this when you are adding QBCore to a server that already exists.

Clone the core resource

cd resources/[qb]
git clone https://github.com/qbcore-fivem/qb-core.git

Add oxmysql

Download the latest oxmysql release and extract it into your resources folder.

Import the SQL

Import qb-core/qb-core.sql into your database. Later resources ship their own SQL files — import each as you add it.

Configure server.cfg

set mysql_connection_string “mysql://user:password@localhost/qbcore?charset=utf8mb4”
set onesync on
ensure oxmysql
ensure qb-core

ℹ️

The database connection is set in server.cfg through the oxmysql connection string, not in qb-core/config.lua. Guides that tell you to edit database credentials inside the resource are out of date.

Validation

Server reaches "Started resource qb-core" with no errors in the console
Database contains the players, bans and management tables
You can connect, create a character and spawn
Money and position persist across a disconnect and reconnect
Your identifier is in permissions.cfg and the admin menu opens

Persistence is the test that matters. A server that boots but does not save is usually a database user without write permission, or a connection string pointing at the wrong schema.

Rollback

If the deploy fails, revert rather than debug a half-installed server:

Stop FXServer
Drop and recreate the database, then restore your last dump
Restore the previous resources folder and server.cfg
Start the server and confirm players can connect before trying again

Keep the previous resources folder on disk until the new install has run for a full week. See Backups.

Next steps

QBCore structure — the core object and player data
QBCore resources — what ships and what to swap
Setting permissions — make yourself admin

Overview Structure