txAdmin Recipes

txAdmin recipes describe initial server deployment tasks: download resources, create directories, generate configuration and optionally connect to and populate a SQL database. Available recipe templates and their components change over time; inspect the recipe you actually selected.

Which recipe should you choose?

Framework availability in the Popular Recipes list may change. Use the official publisher’s recipe link when a desired template is not listed; verify the repository owner and README first.

Deploy to a clean profile

1. Install FXServer with txAdmin and link your Cfx.re account.
2. Create a fresh profile or staging directory. Back up an existing installation before any migration.
3. Select Popular Recipes or a trusted Remote URL Template supported by your txAdmin version.
4. Review the steps, dependencies, file destinations and permissions. A recipe may download executable code.
5. Provide the Cfx.re registration key , and database credentials only when required.
6. Select Run Recipe and inspect any failed task rather than repeatedly overwriting the same directory.
7. Review the generated server.cfg and select Save & Run Server.
8. Confirm joining, spawning and persistence; for database-backed recipes, also reconnect and verify saved state.

The official QBCore recipe  is one example of why a framework recipe is more than a core-resource git clone: it includes many companion resources and schema imports.

Updating an existing server

Do not re-run a whole installation recipe over modified production data to “update” it. A recipe may replace configuration, resources or SQL data. There is no universal safe “Skip vs Overwrite” dialog for every task.

Instead:

1. Record the installed versions, dependencies and custom patches.
2. Take a restorable backup of txData, resources, configs and any external SQL database.
3. Review upstream changelogs and version compatibility.
4. Test updated resources on a staging copy and run required schema migrations deliberately.
5. Deploy a known revision, restart affected resources through txAdmin and test.
6. Keep the previous revision and a database recovery point ready.

For updates in Git, work on your own deployment repository and review upstream changes per resource. Do not run git remote add upstream ... from an arbitrary resources directory and merge a framework repository into all server resources; those directory layouts are not interchangeable.

Example custom recipe structure

The official recipe engine documents actions such as download_github, connect_database and query_database. It does not document a generic import_database action in the current recipe schema.

A minimal illustrative recipe without SQL:

$engine: 3
name: Example CFX resources
version: 1.0.0
author: Example
description: Example for a clean test profile
tasks:
  - action: download_github
    src: https://github.com/citizenfx/cfx-server-data
    ref: master
    subpath: resources
    dest: ./resources/[cfx-default]

This is an illustration, not a complete startable server: it does not create a server.cfg, registration-key configuration or all the game-server prerequisites. For a complete install, use the CFX recipe. For SQL, use connect_database before query_database, as described by upstream.

Official references

• txAdmin recipe specification 
• Cfx.re txAdmin setup 
• QBCore installation
• txAdmin Deployer vs CI/CD
• Server Backups