FiveM txAdmin Recipes: Deploying QBCore, ESX or a Vanilla Server

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.cfg such as {{svLicense}}, {{maxClients}} (48 by default), {{serverEndpoints}} (0.0.0.0:30120 by default) and {{dbConnectionString}}.
• At the end, it checks that the target folder contains a server.cfg and a resources folder, 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:

If you are new, start with the Basic Server recipe, confirm players can join, and then add resources one at a time. Frameworks are large and opinionated: they bring dozens of resources, a database schema and their own permission model, and are far easier to understand after you have seen a clean server boot.

Always check which game version a recipe supports. ChicagoServers customers choose Legacy or Enhanced when they order and can change it later in the control panel, and txAdmin lists separate Basic Server recipes for each, so match the recipe to the version your server uses.

Before you deploy: license key 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 in server.cfg, which the deployer writes for you. 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.

For a framework recipe, create an empty MySQL or MariaDB database first. During the deploy, txAdmin asks for the database connection details and generates a connection string for the recipe. The recipe guidelines also say to accept the random database name that txAdmin generates rather than forcing one.

First-run steps in txAdmin

These follow the official FiveM txAdmin setup guide. On a hosted server the server files are already installed, so you start at the txAdmin screens.

1. Open txAdmin and link your Cfx.re account

   Use the PIN shown on the first-run page, log in to your Cfx.re account when prompted, and click Yes, Allow.

2. Create the admin password

   Choose a password for the txAdmin admin page and continue.

3. Name your server

   Type a server name. txAdmin uses it in the deployment.

4. 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.

5. Review in the Recipe Deployer

   Open the Recipe Deployer and check the recipe looks right. The defaults are normally fine.

6. Enter your license key and run

   Paste the key from the Cfx.re Portal and click Run Recipe. Wait for all tasks to finish.

7. Save and run the server

   When the tasks finish, click Next and then Save and Run Server.

After the deploy: what to check and edit

• Read the generated server.cfg. Recipes are written to work without edits, but they often include comments for the framework. Add your own resources below the framework lines.
• 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.
• Set admins. The template includes add_ace and add_principal lines. 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.

Hosting with ChicagoServers? The GTA V FiveM server hosting page lists what is included, such as free server backups and SFTP file access.

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.
• 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.

Frequently asked questions