<!-- fivemad.com, Markdown source of https://fivemad.com/docs/txadmin/first-setup -->
> Source: https://fivemad.com/docs/txadmin/first-setup
> Section: txAdmin
> Tags: txadmin, setup, deployer, pin, recipe, license key, database
> Last updated: 2026-09-22
> Site map for assistants: https://fivemad.com/llms.txt

# txAdmin first setup and the deployer

Walk through txAdmin's first start: the PIN, linking your Cfx.re account, choosing a recipe or existing server, the deployer steps, license key, database and first launch.

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](/docs/server-setup/windows) or [Linux setup](/docs/server-setup/linux).

[How to Create a FiveM Server with txAdmin (Alfa)](https://www.youtube.com/watch?v=FCIM7FlTA1g) (YouTube video)

## Before you click anything

Have these ready:

- Your **license key** from [portal.cfx.re](https://portal.cfx.re) (starts with `cfxk_`).
- For a framework recipe: MariaDB running, and its **host, port, user and password**. See [Database setup](/docs/server-setup/database).
- 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**:

```text
[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:

| Option | Pick it when |
| --- | --- |
| **Popular Recipes** (some versions say "Popular Template") | You want a fresh server from one of the listed recipes. Most people. |
| **Existing Server Data** | You already have a folder with `server.cfg` and `resources` (moving a server, or a vanilla setup). |
| **Remote URL Template** | You have the URL of a recipe YAML that isn't in the list. |
| **Custom Template** | You want to paste or edit a recipe yourself. |

### 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](https://github.com/citizenfx/txAdmin-recipes). 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](/docs/txadmin/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**.

> [!NOTE]
> The ESX docs point out that txAdmin will not create missing parent directories for you. If you pick a path outside `txData`, create the parent folder first.

## 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:

| Failure | Fix |
| --- | --- |
| GitHub `403` / `429` on a `download_github` task | GitHub rate limited your IP. Wait a few minutes and retry. It happens more on shared hosting IPs. |
| `connect_database` fails | MariaDB not running, wrong password, or the user can't create databases. |
| `query_database` fails | Usually MySQL instead of MariaDB, or a very old MariaDB. Use a current MariaDB. |
| Timeout on a big download | Retry. Recipes can raise `timeoutSeconds` on slow tasks. |

## 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 <kbd>F8</kbd> > `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](/docs/txadmin/everyday-admin#scheduled-restarts).
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](/docs/txadmin/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.

> [!TIP]
> If you redeploy dev servers often, set `TXHOST_DEFAULT_CFXKEY` and the `TXHOST_DEFAULT_DB*` variables so the deployer inputs are prefilled.