FiveM txAdmin Recipes: Deploying QBCore, ESX or a Vanilla Server
A txAdmin recipe is a YAML file that tells txAdmin's built-in Server Deployer how to build a FiveM server: which resources to download, how to configure server.cfg, and optionally how to set up a database. You pick a recipe on txAdmin's setup page, enter your Cfx.re license key, and the deployer does the rest.
The choice that matters is the starting point. A vanilla recipe gives you a minimal working server to build on. A framework recipe such as ESX or Qbox gives you a roleplay base with jobs and an inventory, but needs a database and more care.
- Recipes live in the txAdmin Server Deployer. On ChicagoServers, click the txAdmin button at the top of your server's page, choose a recipe on the setup page, fill in a few details, enter your license key, and click Run Recipe.
- Get your license key from the Cfx.re Portal at portal.cfx.re. On ChicagoServers paste it into the Cfx.re license key field on the Startup tab, then Save startup and Restart. If the deployer asks for it too, use the same key.
- Framework recipes (ESX, Qbox and similar) need a MySQL or MariaDB database, which you create on the Databases tab. The vanilla Basic Server recipe does not.
- txAdmin's own recipe index lists the QBCore recipe as deprecated, so check which maintained recipe you want before you deploy.
- Deploy into a fresh folder, and treat the generated
server.cfgas your starting point, not a finished config.
On this page
What a txAdmin recipe actually does
The txAdmin documentation describes a recipe as a YAML document that explains how to deploy a server properly, from downloading resources to configuring server.cfg. It is a list of tasks that run in order, and any failure stops the process. Common actions are download_github, download_file, unzip, move_path, write_file, replace_string, connect_database and query_database.
- Recipes are "jailed" to the target folder, so they cannot, for example, overwrite txAdmin's own admin list.
- The deployer fills placeholders in
server.cfgsuch as{{svLicense}},{{maxClients}}(48 by default),{{serverEndpoints}}(0.0.0.0:30120by default) and{{dbConnectionString}}. - At the end, it checks that the target folder contains a
server.cfgand aresourcesfolder, so a half-finished deploy is flagged instead of silently accepted.
Because recipes download from GitHub, a recipe with many downloads can hit rate limits. The recipe documentation notes that large numbers of unpinned GitHub downloads can fail with 401 or 403 errors. If a deploy stops partway with a download error, try again a little later.
Which recipe should you pick?
txAdmin's recipe index (the "Popular Recipes" list on the setup page) currently includes:
| Recipe | What it is | Notes |
|---|---|---|
| FiveM Basic Server | A minimal server with the default resources. Separate Legacy and Enhanced versions exist. | No database needed. Best base for building your own server. |
| ESX Legacy | The ESX roleplay framework with job resources. | Maintained under the esx-framework GitHub organization. Needs a database. |
| Qbox Framework | A roleplay base. Its recipe repository describes it as based on ESX, QBCore and Ox. | Needs a database. |
| QBCore Framework | The original QBCore recipe. | Marked deprecated in txAdmin's index. Check the project's own docs before using it. |
| vMenu Enhanced, VORP Core and others | Menu systems and RedM frameworks. | Check each project's page. |
Always check which game version a recipe supports. Your server's edition (Legacy or Enhanced) is the Edition field on the Startup tab, and txAdmin lists separate Basic Server recipes for each, so match the recipe to the edition your server uses.
Always check which game version a recipe supports. ChicagoServers customers choose Legacy or Enhanced when they order, and txAdmin lists separate Basic Server recipes for each, so match the recipe to the version your server uses.
Before you deploy: license key, launch profile and database
Every FiveM server needs a license key from the Cfx.re Portal at portal.cfx.re. It replaces the older Keymaster site. The key goes in sv_licenseKey. On ChicagoServers you enter it in the Cfx.re license key field on the Startup tab (click Save startup, then Restart), and the deployer's own license key step uses the same key. Without a valid key the server will not start properly.
Servers are limited to 48 players by default. Going above that needs a paid Cfx.re Element Club subscription tier, and the limit then depends on the tier and on OneSync Infinity. On ChicagoServers the player slots are set by the panel from your plan.
For a framework recipe, create an empty MySQL or MariaDB database first: open the Databases tab (it shows when your plan includes databases), give it a name and click Create database. Copy the host, database, username and password shown. During the deploy, txAdmin asks for the database connection details and generates a connection string for the recipe; use the values you copied. The recipe guidelines also say to accept the random database name that txAdmin generates rather than forcing one.
Recipes run inside txAdmin, so make sure the launch profile on the Startup tab is txAdmin (the other choice is server.cfg only). Change it, click Save startup, then Restart.
First-run steps in txAdmin
These follow the official FiveM txAdmin setup guide. On ChicagoServers the server files are already installed, so you start at the txAdmin screens: click the txAdmin button at the top of your server's page, which opens txAdmin signed in.
- Link your Cfx.re account if asked
If txAdmin shows its first-run page, use the PIN shown there, log in to your Cfx.re account when prompted, and click Yes, Allow.
- Create the admin password
Choose a password for the txAdmin admin page and continue.
- Name your server
Type a server name. txAdmin uses it in the deployment.
- Pick a recipe
Choose Popular Recipes. For a first run, select the default FiveM template (listed as FiveM Basic Server). Other templates may require a database server.
- Review in the Recipe Deployer
Open the Recipe Deployer and check the recipe looks right. The defaults are normally fine.
- Enter your license key and run
Paste the key from the Cfx.re Portal (the same one in the Cfx.re license key field) and click Run Recipe. Wait for all tasks to finish.
- Save and run the server
When the tasks finish, click Next and then Save and Run Server. You can also use Start and Restart at the top of the panel page.
After the deploy: what to check and edit
- Read the generated server.cfg. On the Configs tab, open server.cfg (the copy the server actually uses is marked In use). Recipes are written to work without edits, but they often include comments for the framework. Add your own resources below the framework lines, then Save and Restart.
- Use the live console. txAdmin includes a live console with a log file, command history and search, plus start, stop and restart controls for the server and individual resources. The panel's own Console tab shows the same server output.
- Set admins. The template includes
add_aceandadd_principallines. txAdmin supplies your master account, and you can add more admins through txAdmin's admin permission system. - Server listing details. Name, description, tags and icon are now configured in the Cfx.re Portal rather than in server.cfg, as covered in the server.cfg guide.
- Schedule restarts. txAdmin supports scheduled restarts with warning announcements and automatic restarts after a crash or hang. The panel's Schedules tab can also run timed restarts and backups.
Hosting with ChicagoServers? The GTA V FiveM server hosting page lists what is included, such as free server backups and SFTP file access. Make a backup on the Backups tab before running a recipe, so you can Restore if it goes wrong.
Common mistakes
- Running a framework recipe without a reachable database, or with a typo in the credentials. The error usually appears early in the deploy.
- Deploying over an existing server folder. Use a new, empty target so the recipe does not mix its files with an old setup, and back up first.
- Using an old Keymaster key or one that was copied wrongly. Generate a fresh key in the Portal.
- Picking a deprecated or unmaintained recipe. Check the repository's last update and its README.
- Assuming the recipe gives you a finished server. A recipe is a starting point. You still need to configure jobs, permissions and rules.
- Installing a framework, then adding conflicting scripts that replace the same functionality. Add one resource at a time and keep notes.
- Starting with the wrong launch profile. Recipes need the txAdmin profile on the Startup tab. If a deploy or start fails, open the Troubleshoot tab and the Console tab for the cause.
Frequently asked questions
What is a txAdmin recipe?
A YAML file that tells txAdmin's Server Deployer which resources to download, how to configure server.cfg and optionally how to set up a database. You run it from the setup page, and it checks for a server.cfg and resources folder at the end.
Where do I get a FiveM license key?
From the Cfx.re Portal at portal.cfx.re. On ChicagoServers, paste it into the Cfx.re license key field on the Startup tab (Save startup, then Restart); the txAdmin deployer asks for it and writes it into server.cfg for you.
Do I need a database for QBCore or ESX?
Yes. Framework recipes use a MySQL or MariaDB database, which you can create on the Databases tab, and txAdmin asks for the connection details during the deploy. The vanilla Basic Server recipe does not need one.
Is the QBCore recipe still available in txAdmin?
txAdmin's recipe index lists the QBCore Framework recipe as deprecated. Check the QBCore project's own documentation, or look at the other roleplay recipes in the index, such as Qbox or ESX Legacy.