Logo

Deploy a FiveM server in 1 command with txAdmin Recipes

Deploy a FiveM server in 1 command with txAdmin Recipes

txAdmin recipes: deploy a full FiveM server (framework, DB, resources) in a few minutes via a YAML recipe. Step-by-step on Wisp at VeryCloud.

Introduction

txAdmin is the reference FiveM admin panel. Its recipes feature lets you clone and configure a full server (ESX, QBCore, or custom) in one action. No more hunting for each resource, installing each dependency, configuring each file: everything is scripted.

Prerequisites

  • A FiveM server at VeryCloud (Wisp panel)
  • txAdmin installed and accessible (default port 40120)
  • An accessible MySQL DB (local or external)
  • URL of a recipe (official or custom)

Step 1: Understanding a recipe

A recipe is a YAML file describing:

  • Files to download (git clone, http download)
  • Resources to unzip / place
  • DB to initialize (SQL imports)
  • Config to generate (server.cfg)

Popular recipes:

RecipeURLFramework
QBCorehttps://github.com/Qbox-project/txAdminRecipeQBox (modern QBCore fork)
ESX Legacyhttps://github.com/esx-framework/txAdminRecipeESX
Standalone(built via txAdmin)No framework

Step 2: Access txAdmin

Your txAdmin URL is http://VERYCLOUD_IP:40120 (or custom domain).

Sign in with your txAdmin admin account.

Step 3: Start server creation

In txAdmin:

  1. Menu → Server
  2. If no server yet, New Deployer appears
  3. Select Use a recipe
  4. Paste the recipe URL

Step 4: Configure the DB

txAdmin asks for MySQL credentials:

Host     : your.mysql.host
Port     : 3306
User     : fivem_user
Password : solid_password
Database : fivem_db

txAdmin tests the connection and creates needed tables.

💡 With an external DB, make sure the FiveM server IP is whitelisted in MySQL GRANTs.

Step 5: License config

Enter your Cfx.re license key (see dedicated tutorial). Format: cfxk_xxxxx....

Without a valid key, txAdmin refuses to deploy.

Step 6: Run the deploy

Click Run Recipe. txAdmin will:

  1. Clone listed Git repos
  2. Download external resources
  3. Import .sql files into the DB
  4. Generate server.cfg with correct ensure lines
  5. Build the server ready to start

3-10 minutes depending on recipe size and bandwidth.

Step 7: First start

Once deploy is done:

  1. txAdmin proposes Start Server
  2. Watch logs for errors
  3. Connect in-game: F8 then connect VERYCLOUD_IP

Step 8: Build your own recipe

You can write your own recipe to reproduce your server on other instances. Basic structure (recipe.yaml):

$onesync: on
$minFxVersion: 7290
$engineVersion: 2802

tasks:
  - action: download_github
    src: https://github.com/qbcore-framework/qb-core
    dest: ./resources/[qb]/qb-core

  - action: download_file
    url: https://example.com/myaddon.zip
    path: ./tmp/myaddon.zip

  - action: unzip
    src: ./tmp/myaddon.zip
    dest: ./resources/myaddon

  - action: connect_database

  - action: query_database
    file: ./resources/[qb]/qb-core/qb-core.sql

  - action: write_file
    file: server.cfg
    data: |
      sv_licenseKey {{cfxLicense}}
      sv_hostname "My QBCore Server"
      ensure qb-core
      ensure oxmysql

variables:
  - name: cfxLicense
    type: string
    prompt: "Cfx.re license key"

Push to GitHub, share the URL: anyone can deploy the same base.

Step 9: Updates after deploy

Once deployed, don't run a second recipe on the same server (would overwrite). To update, do manual git pull in resource folders, or use txAdmin Updater for supporting resources.

Step 10: Post-deploy backup

First thing after a successful deploy: backup via Wisp Schedules. You want to return to a "fresh" state if a change breaks everything.

Troubleshooting

Invalid recipe URL — must point to a GitHub repo with recipe.yaml at root. Test: curl https://raw.githubusercontent.com/user/repo/main/recipe.yaml. Database connection failed — credentials, source IP whitelisted in MySQL, port 3306 firewalled. Task X failed — read txAdmin Deployer logs. Often a download_github pointing to a renamed/deleted repo. Fork and adapt. Server boots then crashes loop — resource conflict (two trying to manage the DB). Disable resources one by one.

Useful commands

# Re-run part of a recipe manually
cd /resources && git clone <url> <name>

# Validate recipe before publishing
yamllint recipe.yaml

Conclusion

txAdmin recipes = standardized, reproducible FiveM server setup in 10 minutes. Ideal for dev → staging → prod reproduction, or a clean kickstart for a new project. Combine with CI/CD for automated updates.

Going further: custom recipes for your org, automated deploy via txAdmin API, CI integration.

Resources

Join our Discord community server

For any questions, suggestions, or just to chat with the community, join us on Discord!

900+Members