txAdmin first setup and the deployer

This page goes through txAdmin’s first run screen by screen. It is the same on Windows and Linux. If you haven’t downloaded an artifact yet, start with Windows setup or Linux setup.

How to Create a FiveM Server with txAdmin (Alfa)

Before you click anything

Have these ready:

• Your license key from portal.cfx.re (starts with cfxk_).
• For a framework recipe: MariaDB running, and its host, port, user and password. See Database setup.
• Optional: your Discord user ID if you want txAdmin to know it right away.

Step 1: start FXServer and open the panel

Run FXServer.exe (Windows) or bash run.sh (Linux) with no arguments. The console prints the panel address and a PIN:

[txAdmin] Use the PIN below to register:
[txAdmin]  5820
[txAdmin] http://localhost:40120/

Open the address. On a VPS use the server’s public IP. The PIN proves you have access to the console, so nobody else who finds the page first can claim your server.

Step 2: link your account

1. The PIN field should be filled already. Click Link Account.
2. Log in with your Cfx.re account (the forum account) and approve txAdmin.
3. Set a backup password. You’ll use it only if Cfx.re login is down.

You are now the master account. It can’t be removed by other admins and has every permission.

Step 3: name the server

Type the name you want txAdmin to use (in the panel, Discord embed and logs). You can change it later in Settings > General. This is not sv_hostname, which lives in server.cfg.

Step 4: choose how to set up

You get these options:

Existing server data

Point txAdmin to the folder that contains server.cfg and resources, then to the cfg file. txAdmin checks both and starts it. Nothing is downloaded.

Step 5: pick a recipe

The Popular Recipes list comes from the txAdmin-recipes index. At the time of writing it includes:

• FiveM Basic Server (Legacy and an Enhanced variant): the default Cfx resources, no framework.
• ESX Legacy, Qbox, QBCore: roleplay frameworks. Need MariaDB.
• vMenu (via a recipe patch), StreetKings (racing), WarfareTacticsV (RTS) and RedM’s VORP Core.

See Popular recipes for what each one installs.

Step 6: choose the data location

txAdmin suggests a folder inside txData named after the recipe with a random suffix, like txData/QBCore_4F2A1C.base. You can change it. The folder must be empty or not exist yet. Click Save.

Step 7: the Recipe Deployer

This screen shows the recipe YAML. Read it once: it tells you exactly what will be downloaded. Click Next.

Now fill in the inputs:

• License key: paste your cfxk_ key.
• Database (framework recipes only): host localhost, port 3306, user, password. Leave database name empty to let txAdmin create one with a random name. The delete database if it exists option exists for redeploys, careful with it.
• Some recipes ask for extra values, like a Steam Web API key (recipes with $steamRequired).

Click Run Recipe. The deployer runs each task in order and shows a log. A failure stops it and shows which task failed. Common failures:

Step 8: review server.cfg and start

txAdmin shows the generated server.cfg. The recipe placeholders are already filled in: your key, endpoint_add_* lines, sv_maxclients (48 by default), and add_principal lines that make your identifiers admin. Change sv_hostname, sets tags, sets locale if you like, then click Save & Run Server.

The panel switches to the Live Console. First boot takes longer:

• The artifact caches files.
• Some recipes (QBCore in particular) build resources with yarn on first start. Let it finish.
• Framework resources run database migrations.

When the console settles and shows resources started without red errors, connect with F8 > connect localhost:30120 (or your IP).

Step 9: first things to set

1. Settings > FXServer: turn on starting the server automatically when txAdmin boots.
2. Settings > Restarter: add scheduled restart times (for example 06:00 and 18:00). See Everyday admin.
3. Admin Manager: add your staff with only the permissions they need.
4. Settings > Discord Bot if you want the status embed. See Discord bot.
5. In game, type /tx to check the menu works for you.

Starting over

To redeploy from scratch: stop the server, delete (or move) the server data folder, and use txAdmin’s Master Actions page (master account only), which has an option to reset the FXServer settings and bring you back to the setup page. Keep txData/default if you want to keep your bans and player database.