txAdmin: first-time setup of a FiveM server

txAdmin is a web panel for managing a FiveM server: it deploys the server from a ready-made recipe, monitors and restarts it, and manages admins, bans and the whitelist. We'll go through the first launch from the PIN to a running server and explain every field of the setup wizard.

How txAdmin works#

txAdmin is part of every FiveM server (FXServer), so there's nothing to download separately. When FXServer starts without the +exec server.cfg parameter, txAdmin starts instead of the game server itself. txAdmin then starts the game server, monitors it and restarts it automatically if it crashes or freezes.

• txAdmin keeps its data (admin accounts, settings, logs, the player and ban database) in the txData folder.
• The web interface runs on its own port. The default port is 40120, but on our servers it may be different.
• The interface is in English. This guide gives button names exactly as you'll see them.

Opening txAdmin#

1. In the customer area, open My services, click your FiveM server and go to the Console tab.

2. If the server isn't running, click Start.

3. Wait for the box with the text All ready! Please access:.

   All ready! Please access:
   http://your-public-ip:40120/
   
   Use the PIN below to register:
   1234

   • The line below All ready! Please access: is the txAdmin address. What matters is the port (the number after the colon).
   • Below Use the PIN below to register: is a four-digit PIN for the first sign-in. It's shown until you create the first admin.

4. Type the address http://<IP_ADDRESS>:<TXADMIN_PORT>/ into your browser.

   Replace <IP_ADDRESS> with the IP address from the Network tab (only the part of the Connection address line before the colon, for example 203.0.113.10). Replace <TXADMIN_PORT> with the port from the box in the console. The full address then looks like http://203.0.113.10:40120/.

   If you see a hatched bar instead of the IP address, streamer mode is on. Click Show details at the top. Streamer mode also hides IP addresses in the console output, including the port after them. You can then read the txAdmin port from the http://your-public-ip:<PORT>/ line, or show the details.

   We don't assign the txAdmin port automatically yet. If you don't see it in the Network tab (Connection address or Additional ports), ask us for a txAdmin port (contacts). Without it, txAdmin won't open in your browser.

If the box doesn't appear and the console goes straight to loading resources (Started resource …), txAdmin is turned off. Turn it on in the Settings tab › Variables with the txAdmin variable (1 = on, 0 = off) and restart the server. If you don't see such a variable, contact us (contacts).

Linking your Cfx.re account and password#

Your first sign-in creates the main admin (Master). This admin has all permissions and is the only one that can't be deleted.

1. On the No Cfx.re account linked page, enter the PIN from the console (Type in the PIN from the terminal.).

2. Click Link Account.

3. Sign in with your Cfx.re account and confirm access with Yes, Allow.

   You return to txAdmin, to the registration form.

4. Fill in the form:

   Field	What to enter	Why
   Discord ID	Optional. Your numeric Discord user ID.	Links the admin to Discord (whitelist, txAdmin bot commands). You can add it later.
   Backup Password	A password 6–⁠128 characters long. Use the password generator.	A fallback sign-in for when Cfx.re sign-in doesn't work.
   Confirm Password	The same password again.	Catches typos.

5. Accept the license terms (Creator PLA) and click Register.

   The server setup wizard opens.

Server setup wizard#

Server Name#

A short server name for the txAdmin interface and for messages in chat and on Discord, for example Muj RP server. The field accepts at most 18 characters. This isn't the name in the FiveM server list (that's set in server.cfg). Click Next.

Deployment Type#

For your first server, choose Popular Recipes and pick a recipe:

• Basic recipe (listed as FiveM Basic Server or CFX Default FiveM, depending on the txAdmin version) – a minimal server without a framework and without a database. Good for trying things out and for freeroam and drift servers.
• ESX Legacy, QBCore Framework, Qbox Framework – roleplay frameworks. They need a database. The differences and how to choose are covered in ESX, QBCore or Qbox?.

Server data folder#

txAdmin suggests where to deploy the server, typically txData/<NAME>_<CODE>.base. Keep the suggested path (We strongly recommend using the path suggested below.) and click Save. server.cfg and resources are stored in this folder.

On the last screen (We are almost there!), click Go to Recipe Deployer. Before you continue, prepare the database (next section).

Preparing the database#

Framework recipes (ESX, QBCore, Qbox) need a database. Before you continue in txAdmin, create it in the customer area. The basic recipe doesn't need a database, so skip this section if you use it.

1. In the customer area, go to the Database tab.

2. In the Database name field, type for example fivem (letters, numbers and underscores only).

3. Leave the Allowed connections from field at %. The % sign means “from anywhere”, so both the server and your computer can connect to the database.

4. Click Create database.

   The list shows Database name, User, Host and Password. Keep the details open; you'll copy them into txAdmin in a moment. Copy the database name exactly from the list, as it may differ from what you typed.

Deploying the recipe (Server Deployer)#

Step 1: Review Recipe#

txAdmin shows the contents of the recipe: what it downloads, where it stores it and which SQL it runs. Only run recipes from trusted sources (Only run Recipes from trusted sources!). Click Next.

Step 2: Input Parameters#

The database fields appear after you click Show/Hide Database options (advanced). Then click Run Recipe.

Step 3: Run Recipe#

txAdmin downloads files and imports SQL. For large recipes (QBCore, Qbox) this can take several minutes. When it's done, click Next.

Step 4: Configure server.cfg#

You'll see the generated server.cfg. Now check and adjust three things; everything else is explained in server.cfg line by line:

• endpoint_add_tcp and endpoint_add_udp – the port after the colon must be the game port from the Connection address line in the Network tab (the number after the colon). If txAdmin didn't get the port from the host, it writes the default 30120. If they differ, change it on both lines, otherwise players won't be able to connect.
• sv_hostname and sets sv_projectName – the server name in the server list.
• sets locale "root-AQ" – change it to your players' language, for example sets locale "en-US" (or "cs-CZ" for Czech), so the server list shows the right language.

Click Save & Run Server. The server starts and txAdmin opens Live Console.

Verification#

• In txAdmin, the Dashboard page shows the server as online, and there are no red errors in Live Console.
• In the game, press F8, type connect <IP_ADDRESS>:<PORT> (the address from the Connection address line in the Network tab) and connect.
• In the game, type /tx (or /txadmin) in chat: the txAdmin menu opens. It only works for admins who have a Cfx.re or Discord ID filled in in txAdmin. You can set a key for the menu in the game under Game Settings › Key Bindings › FiveM (the (txAdmin) Menu: Open Main Page item).

Managing admins#

1. Click Admins in the top menu.

2. Click Add.

3. Fill in the form:

   Field	What to enter
   Username	The username for signing in to txAdmin. If you fill in Cfx.re ID, it must match the name on the Cfx.re forum.
   Cfx.re ID	Optional. The username on forum.cfx.re (opens in a new window). Allows signing in with the Cfx.re button and using the /tx menu in the game.
   Discord ID	Optional. The numeric Discord user ID.
   Permissions	Tick only what the person really needs (table below).

4. Save. txAdmin shows a temporary password; send it to the admin. They must change it at their first sign-in.

Permissions are stored in the txData/admins.json file. A txAdmin admin isn't automatically an admin in the framework (ESX, QBCore). How to give permissions in the framework is described in ESX, QBCore or Qbox?.

Scheduled restarts#

A regular restart (once or twice a day) frees memory and clears out broken script state. txAdmin warns players in advance.

1. Click Settings in the top menu and open the FXServer tab.
2. Under Restart Schedule, click the + button. In the Add Restart Time dialog, enter a time, for example 06:00. Instead, you can click a ready-made preset (1x/day, 2x/day …).
3. Save the settings.

The time follows the server time, not your computer's (Make sure your schedule matches your server time and not your local time.). If txAdmin shows a time zone warning, shift the time by the difference.

Useful parts of txAdmin#

Troubleshooting#

The txAdmin page won't load#

• Check that the server is running and the console shows the All ready! Please access: box.
• Use the IP address from the Network tab and the port from the box. The address starts with http://, not https://.
• If your browser changes the address to https:// on its own, type it manually including http://.
• The txAdmin port must be among the server's ports in the Network tab (Connection address or Additional ports). If you don't see it there, contact us.

The PIN doesn't work#

A new PIN is generated at every startup until you have the first admin. Use the PIN from the latest console output. Once an admin exists, the PIN is no longer shown; sign in with the Cfx.re button or with your password.

I forgot my password#

Sign in with the Cfx.re button. If that doesn't work either and you're the only admin, contact us. Deleting the txData/admins.json file makes txAdmin go back to the PIN, but you lose all admin accounts.

Task Failed: Response code 403 (rate limit exceeded)#

The recipe downloads dozens of repositories from GitHub, and GitHub has temporarily limited the number of downloads. Wait about an hour and run the deployment again.

The recipe fails with a database error (ER_ACCESS_DENIED_ERROR, ECONNREFUSED)#

• ER_ACCESS_DENIED_ERROR – wrong user or password. Copy them again from the Database tab, without spaces at the start or end.
• ECONNREFUSED or a timeout – wrong address or port. Database Host needs the IP address from the Host field, not localhost.
• ER_BAD_DB_ERROR – the database name doesn't match. Copy it exactly from the list of databases.

Other database errors are covered in Database for FiveM.

The server won't start after deployment#

The most common cause is a missing or wrong license key (Could not authenticate server license key). Fix it in CFG Editor following the license key guide. You'll find other errors in Common FiveM errors.

Players can't connect even though txAdmin says online#

Players connect to the game port from the Connection address line, not to the txAdmin port. In CFG Editor, check the endpoint_add_tcp and endpoint_add_udp lines: both must have the port from the Connection address, not the default 30120 from the recipe (unless that happens to be your port). Restart the server after fixing it. More in the server.cfg guide.

Further reading#

• FiveM: Setting up a server using txAdmin (opens in a new window)
• FiveM: txAdmin and its permissions (opens in a new window)
• txAdmin on GitHub (recipe and variable documentation) (opens in a new window)