txAdmindocs
Deployment guides

Install QBCore with txAdmin

Deploy QBCore from the official txAdmin recipe and confirm MySQL, resource startup order and character persistence.

QBCore's maintained txAdmin recipe is a starting point for a FiveM roleplay server. Deploy it to isolated files and database storage before adding paid scripts or migrating a live community.

Before deployment

  1. Install and launch FXServer with txAdmin.
  2. Prepare your license key and a clean MySQL/MariaDB database for the new installation.
  3. Review QBCore's recipe source and its referenced dependencies.
  4. Note current versions. Back up an existing framework and SQL database before replacing anything.

Deploy with the official recipe

  1. In txAdmin Server Deployer, choose QBCore.
  2. Confirm the selected recipe's publisher and URL; use the maintainer's current recipe when importing manually.
  3. Enter the server name and Cfx key, then database connection details where prompted.
  4. Review file-writing and SQL tasks and ensure destructive database operations cannot touch production.
  5. Watch each task until the deployer finishes. If it stops with 403/404, check the exact source or GitHub rate limits.
  6. Review server.cfg resource order, license placeholders and database connection without publishing secrets.

Test the result

TestExpected result
BootNo missing QBCore core dependencies or resource startup errors
JoinTest client can connect and character creation loads
DatabaseCharacter information persists across disconnect and restart
AdmintxAdmin web and in-game staff permissions work independently
Update readinessArtifact and recipe versions plus recoverable backup are documented

For comprehensive framework APIs, use the maintained QBCore project documentation; txAdmin manages the hosting and deployment layer, not QBCore's resource interfaces.

QBCore vs Qbox

Qbox and QBCore are different deployments. Their recipes, release expectations and third-party resource support are not interchangeable. If starting with Qbox, use the Qbox recipe guide.

Sources: QBCore recipe, official recipe listing, task syntax.

On this page