<!-- fivemad.com, Markdown source of https://fivemad.com/docs/txadmin -->
> Source: https://fivemad.com/docs/txadmin
> Section: txAdmin
> Tags: txadmin, admin panel, deployer, recipes, bans, restarts, discord bot
> Last updated: 2026-09-22
> Site map for assistants: https://fivemad.com/llms.txt

# txAdmin overview

What txAdmin is and does: the recipe deployer, web panel, in-game menu, bans and warns, whitelist, scheduled restarts, Discord bot, live console and monitoring.

txAdmin is the web panel and in-game admin menu for FiveM and RedM servers. It was created by tabarra in 2019, has been part of FXServer since early 2020, and is now maintained under the Cfx.re GitHub organisation ([citizenfx/txAdmin](https://github.com/citizenfx/txAdmin), MIT licensed). The project says it runs on over 29,000 servers at any given time.

You don't install it. **Run FXServer without `+exec server.cfg` and txAdmin starts**, creates a `txData` folder, and serves its panel on port `40120`.

## What it does

### Deploy servers

The **recipe deployer** builds a complete server from a YAML recipe: downloads resources from GitHub, creates and imports the database, writes `server.cfg`. The setup page lists "Popular Recipes" (a basic FiveM server, ESX Legacy, Qbox, QBCore and a few game modes) and accepts any recipe URL. See [Recipes explained](/docs/txadmin/recipes) and [Popular recipes](/docs/txadmin/popular-recipes).

### Run and watch the server

- Start, stop and restart FXServer, and start or stop single resources.
- **Auto restart** on crash or hang.
- **Scheduled restarts** at fixed times, with in-game warnings 30, 15, 10, 5, 4, 3, 2 and 1 minutes before.
- **Live Console** with a log file, command history and search.
- **Performance chart** of server thread times against player count, plus CPU and memory use.
- **Server activity log**: joins, leaves, kills, chat, explosions and custom commands.
- A **CFG editor** for `server.cfg`.

### Manage players

- Real time player list, player search and player info (play time, identifiers, notes).
- **Warns** (players must acknowledge them in game), **kicks** and **bans**, temporary or permanent, including hardware ID bans.
- **Whitelist** modes: approved license, Discord server member, Discord role, or admin only.
- A self contained player database, no MySQL needed.

### In-game menu

Type `/tx` (or `/txadmin`) in game to open it. It has NoClip, god mode, super jump, teleport (waypoint, coords, back), vehicle spawn, fix, delete and boost, heal, announcements, world area reset, player IDs, and player actions: go to, bring, spectate, freeze, warn, ban, DM and a few troll options. Access requires a txAdmin account linked to your Cfx.re or Discord identifier.

### Discord bot

An optional bot posts a **persistent status embed** that updates every minute, and has commands to whitelist players and show player info. See [Discord bot](/docs/txadmin/discord-bot).

### Access control

Login with Cfx.re or password, per admin **permissions**, and an **action log** of what every admin did.

## Pages in this section

1. [First setup and the deployer](/docs/txadmin/first-setup): from first start to a running server.
2. [Recipes explained](/docs/txadmin/recipes): the YAML format, every task action, variables.
3. [Writing your own recipe](/docs/txadmin/writing-recipes): a complete example that installs a small framework stack.
4. [Popular recipes](/docs/txadmin/popular-recipes): what the Basic Server, QBCore, Qbox and ESX Legacy recipes install.
5. [Everyday admin](/docs/txadmin/everyday-admin): players, bans, warns, whitelist, restarts, backups, console, logs, admins.
6. [Discord bot](/docs/txadmin/discord-bot): setup, status embed, whitelist.
7. [Updating txAdmin and FXServer](/docs/txadmin/updating).

## Settings that live outside the panel

Since txAdmin v8, host level settings are **environment variables** named `TXHOST_*`, set before FXServer starts (in your `.bat`, `run.sh`, systemd unit or Docker env file). The ones you are most likely to need:

| Variable | Default | Use |
| --- | --- | --- |
| `TXHOST_DATA_PATH` | Windows: folder next to the artifact folder. Linux: next to `run.sh`. | Where `txData` lives. Use one per server. |
| `TXHOST_TXA_PORT` | `40120` | txAdmin web port. Cannot be 30120. |
| `TXHOST_FXS_PORT` | not set | Forces the game port by rewriting `endpoint_add_*`. Cannot be 40120. |
| `TXHOST_INTERFACE` | `0.0.0.0` | Interface txAdmin (and FXServer) bind to. |
| `TXHOST_MAX_SLOTS` | not set | Caps `sv_maxclients`. |
| `TXHOST_DEFAULT_CFXKEY` / `TXHOST_DEFAULT_DB*` | not set | Prefills the deployer, handy when you redeploy dev servers often. |

The old convars `txAdminPort`, `txAdminInterface` and `txDataPath` are deprecated. Full list in the [env-config docs](https://github.com/citizenfx/txAdmin/blob/master/docs/env-config.md).

## For script developers

txAdmin broadcasts server events you can listen to, named `txAdmin:events:<name>`, for example:

- `txAdmin:events:scheduledRestart` (with `secondsRemaining`), useful to save players before a restart,
- `txAdmin:events:serverShuttingDown`,
- `txAdmin:events:playerBanned`, `playerKicked`, `playerWarned`, `playerDirectMessage`,
- `txAdmin:events:playerHealed`, which frameworks use to revive a downed player when an admin heals them,
- `txAdmin:events:announcement`.

```lua title="server/main.lua"
AddEventHandler('txAdmin:events:scheduledRestart', function(data)
    if data.secondsRemaining == 60 then
        print('Restart in one minute, saving everything')
        -- save your resource's data here
    end
end)
```

The full list is in [events.md](https://github.com/citizenfx/txAdmin/blob/master/docs/events.md).