Skip to main content

Enable and configure txAdmin

This complete guide explains how to enable and configure txAdmin on your FiveM server.

What is txAdmin?​

txAdmin is a complete administration panel for FiveM that allows you to:

  • Manage your server (start, stop, restart)
  • Moderate players with an integrated administration menu
  • View logs in real-time
  • Manage bans and permissions
  • Install template bases (ESX, QBCore, etc.)

Step 1: Enable txAdmin​

For YorkHost Game servers​

  1. Go to the client area: clients.yorkhost.fr
  2. Select the service on which you want to enable txAdmin
  3. Click the Quick Action button, then click Enable txAdmin
info

After clicking, wait a maximum of 2 minutes. Your port will be added and your server will restart automatically. If not, open a ticket.

txAdmin enabled by default when ordering

When ordering a Game plan on yorkhost.fr, the txAdmin enabled option is available and checked by default. If you did not uncheck this option when placing your order, txAdmin is already enabled on your server and you can skip directly to Step 2.

Activation via the AI chatbot

You can also request txAdmin activation through our AI chatbot available at the bottom right of the client area.

For Pterodactyl resellers​

  1. Add an allocation (a port) to the server in question
  2. In Startup, set txAdmin to 1
  3. Enter the port you just added in txAdmin Port

Step 2: Configure startup parameters​

In the game panel, configure the following variables:

VariableValue
txAdmin PortThe allocated port for txAdmin
Enable txAdmin1
  1. Start your server
  2. In the console, a link will appear (example: http://83.150.218.66:40100/)
  3. Click on this link or copy it into your browser
tip

Look in the console under "Your public IP" to find the access link.

txAdmin Configuration​

First connection​

When opening txAdmin for the first time:

  1. Enter the Master PIN Code displayed in your console
  2. Link your CFX account (Cfx.re)
  3. Choose your configuration type

Two options are available:

  • Existing Server Data: Use your own base or the one installed by default
  • Popular Recipes: Install a template base (ESX, QBCore, etc.)

Option A: Configuration with your own base​

1. Server name​

Configure your server name that will appear in txAdmin.

2. Select "Existing Server Data"​

Choose this option if you already have server files.

3. Configure locations​

The server root is /home/container/. Enter this path for your data.

4. Start the server​

Click Save & Run Server to start.

Option B: Configuration with a template base​

This option allows you to install a base like ESX Legacy, QBCore, etc.

Preparation​

Important

Before starting, delete the default server that was installed on the panel (files in /home/container/).

1. Server name​

Configure your server name.

Choose this option to install a template.

3. Choose the template​

Select the desired base (example: ESX Legacy, QBCore, vRP, etc.).

4. Location​

Leave the default location for now. We will move the files later.

5. Configure parameters (Input Parameters)​

Server Registration Key (CFX Key)​

Enter your CFX key in the format cfxk_.... You can:

  • Use your own key
  • Use the default one (in startup parameters)

Database configuration​

Expand the "database" section and configure it.

6. Create the database​

Return to the game panel:

  1. Go to the Databases tab
  2. Click New Database
  3. Give it a name (no spaces or special characters, example: base)
Warning

Do not modify the "Connected from" field!

You will get the connection information:

  • Host
  • Port
  • Database name
  • Username
  • Password

7. Finalize configuration in txAdmin​

Return to txAdmin and enter the database information.

Important check

Make sure the Delete Database option is set to OFF!

8. Execute the Recipe​

Click Run Recipe and wait during the installation.

9. Configure server.cfg​

After installation, you can modify the server.cfg file.

Important: Modify the endpoint port to match your server port.

Example: If your server IP is 83.150.218.66:30100, the port is 30100.

endpoint_add_tcp "0.0.0.0:30100"
endpoint_add_udp "0.0.0.0:30100"

Click Save & Run Server.

Move files (template bases)​

After the first launch with a template, you need to move the files:

1. Stop the server​

Completely stop the server from the panel.

2. Locate the files​

Go to /txData/ then to your base folder (example: ESXLegacy_839419.base).

3. Move essential files​

Move these files/folders to the root (/home/container/):

File/FolderMove to
resources/resources
server.cfg/server.cfg

To move: click on the 3 dots → Rename/Move → modify the path.

4. Delete the old folder​

Once the files are moved, delete the base folder in /txData/.

5. Modify txAdmin configuration​

Edit the file /txData/default/config.json:

{
  "dataPath": "/home/container/"
}

6. Restart​

Restart your server. You can now connect!

Tips​

Reconfigure txAdmin​

If you want to reconfigure txAdmin from scratch:

  1. Delete the txData folder
  2. Restart the server
  3. Configuration will start from the beginning

Configuration error​

If you see an error indicating that txAdmin is already configured:

  • Delete the txData folder
  • Start the configuration again

Common problems​

ProblemSolution
txAdmin port not accessibleCheck that the port is allocated in the panel
Database errorCheck credentials and that the DB exists
Server won't startCheck the logs in txAdmin
Invalid Master PINRestart the server to get a new PIN
Need help?

If you encounter a problem, open a ticket on clients.yorkhost.fr with your server logs.