How do I install QBCore on my FiveM server with txAdmin?

QBCore is the most popular roleplay framework for FiveM, but installing it by hand — dozens of resources, a database and a working server.cfg — is error-prone. The good news: txAdmin ships a ready-made recipe that sets up the entire framework for you in minutes. In this guide you will create a database in the panel, deploy the QBCore recipe through the txAdmin setup wizard and finally log into your own city as an admin.

QBCore or Qbox? Qbox (qbx_core) is a modern continuation of QBCore, with active development, better performance and tighter security. The txAdmin recipe list contains both frameworks and the steps below are identical for either one; if you prefer Qbox, simply pick that recipe in step 3. Starting completely fresh without any QBCore-specific scripts? Then Qbox is well worth considering.

Step 1: Create a database in the panel

1. Log in to the MC-Node panel and open your FiveM server.
2. Go to the Databases tab and click New Database. If you do not see the button or have hit your limit, read How do I create and manage a database?
3. Give the database a recognisable name, for example qbcore, and confirm.
4. Open the details of the new database and write down four things: the endpoint (the host, including the port number after it), the database name, the username and the password (visible via the eye icon).

Note: the host is a dedicated database address, not localhost. If you enter localhost or 127.0.0.1 later on, your server will never be able to reach the database. More background can be found in How do I connect to my database?

Step 2: Open txAdmin

1. Check that txAdmin is enabled on your server. If it is not yet, first follow How do I enable txAdmin?
2. Start your server from the Console tab.
3. The console output shows the txAdmin address together with a four-digit PIN code. The PIN is only valid for a few minutes; if it has expired, restart your server to get a new one.
4. Open the address (http://server-ip:txadmin-port) in your browser, sign in with your Cfx.re account and enter the PIN. This linking step is only needed once: your account then becomes the master account of this txAdmin.

Step 3: Deploy the QBCore recipe through the setup wizard

1. Because no server has been configured yet, txAdmin automatically opens the setup wizard. Give your server a name.
2. For the installation type choose Popular Recipes and select QBCore Framework (or Qbox).
3. Enter your Cfx.re license key. You can create one for free at portal.cfx.re; exactly how that works is covered in I bought a FiveM server, what now?
4. In the database fields, enter exactly the details from step 1: host (with port number), username, password and database name.
5. Start the deployment. txAdmin now downloads all QBCore resources, imports the SQL tables into your database and generates a server.cfg. This usually takes a few minutes.
6. Afterwards, review the generated server.cfg (the defaults are fine to start with) and click Save & Run Server.

Step 4: First start, becoming admin and entering the city

1. Watch the first start in the txAdmin console and wait until all resources have loaded and no more red errors scroll by.
2. Open the FiveM client, press F8 and type connect ip:port using your server's address (you can find it in the panel).
3. You will land in the character menu: create your first character and pick a starting location or apartment.
4. Becoming admin: open the Live Console page in txAdmin and type setgroup 1 god, replacing 1 with your server ID (shown on the Players page in txAdmin). With the god group you can open the admin menu in the city, by default via /admin.

Common problems

• Connection refused or Access denied (oxmysql) — the database details are wrong. The recipe writes them to the set mysql_connection_string line in server.cfg; open that file via the Files tab and double-check the host including the port number, the username (including any prefix), the password and the database name. Never use localhost. Then restart your server.
• Recipe run over an existing installation — the deployer expects a clean environment. If you run the wizard on top of an earlier installation, you end up with conflicting resources and duplicate database tables. First take a backup via the Backups tab, then remove the old server files (or have your server reinstalled) and use an empty or fresh database.
• License key missing or already in use — FiveM will not start without a valid key, and one key can only run on one active server at a time. Create a new key on Keymaster and update it via the Startup tab; the details are in How do I change my FiveM license key?
• The txAdmin page does not load — check that the txAdmin port has been configured and that your server is actually running; the steps are in the txAdmin article from step 2.

Need help?

Congratulations, your city is live! From here you can add resources, configure jobs and shape your server further. Still stuck somewhere, for example on a deployment that stops halfway? Open a ticket via our support page and include your server name and the error from the txAdmin console — we will gladly take a look with you.