Server recipes
Understand what a recipe deploys and choose a safe starting point.
A recipe is a YAML document with metadata, variables, and sequential tasks. txAdmin’s Server Deployer runs those tasks to download resources, configure files, and prepare a server.
Choose a starting point
Prefer a recommended recipe or the framework maintainer’s current recipe. Match the recipe to FiveM or RedM and check its required database and minimum FXServer version. A recipe is a starting point; the resulting framework and resources still need configuration and maintenance.
Before running it
- Read the source URL and recipe tasks.
- Choose a new, empty deployment folder.
- Keep existing production files and databases backed up.
- Confirm which database will be used and whether an option removes existing data.
- Have the Cfx.re key and database details ready.
Recipe file operations are restricted to the target folder. That boundary does not make an unreviewed download or database query trustworthy.
What happens during deployment
Tasks execute in order and stop at the first failure. The deployer expects server.cfg and a resources folder at the end. Standard actions include download_github, download_file, unzip, replace_string, connect_database, and query_database.
Downloads can fail because of an unavailable repository, invalid reference, network failure, or GitHub rate limits. Database tasks can fail because the host, credentials, permissions, or SQL are wrong. Diagnose the failing task instead of repeatedly redeploying.
Write your own recipe
Use the preserved Recipe files reference for the full metadata, context variables, and task syntax. Pin source references when you need reproducible deployments. Test a custom recipe in an isolated folder and database first.
Source: txAdmin upstream documentation.