FiveUnityManual

txAdmin

txAdmin is the admin panel most FiveM servers already run. Connecting it gives FiveUnity three things the bridge resource cannot do on its own: permanent bans, kicks by in-game server ID, and a live server dashboard in Discord.

Note

Where: Dashboard โ†’ Roleplay โ†’ FiveM โ†’ txAdmin ยท In Discord: /dashboard, /fivem-ban, /kick-id

#Connect txAdmin

The txAdmin section sits on the FiveM page, below Vouch. Fill in the three fields, then press Save in the FiveM bridge section header at the top of the page; that one button saves the whole page, including the password.

SettingWhat it does
txAdmin URLThe base address of your txAdmin instance, for example https://your-server:40120. It must start with http:// or https://, and a trailing slash is removed for you.
txAdmin usernameRecorded alongside the credentials. Actions FiveUnity performs are recorded in txAdmin as FiveUnityBot.
txAdmin passwordThe credential sent with every request, as an X-TxAdmin-Token header. Once saved the field reads Stored (type to replace) and the hint below it shows whether one is set. 4-200 characters.
Warning

FiveUnity talks to txAdmin through a token-authenticated API at <txAdmin URL>/status and <txAdmin URL>/fxserver/commands, sending the password field as the token. It never logs in through the txAdmin web page. If your txAdmin answers those addresses with its login page instead, you will see the "Received HTML response" error below. Check with FiveUnity support which txAdmin setup your server needs before relying on bans and kicks.

The password is write-only. It is never returned to the dashboard, so reloading the page will never show it and there is no way to read it back: if you lose it, set a new one in txAdmin and paste that.

If your txAdmin runs on a private or LAN address, turn on Allow private / LAN addresses in the FiveM bridge section first; otherwise saving the URL is refused with "That txAdmin URL resolves to a private or loopback range." Link-local and cloud metadata addresses stay blocked either way.

Note

txAdmin is set up on the dashboard only. Some Discord error messages point at /setup โ†’ FiveM โ†’ txAdmin Setup; use Dashboard โ†’ Roleplay โ†’ FiveM instead.

#What it powers

#/dashboard

Posts a ๐Ÿ“Š Server Dashboard embed with the server status, the player count against your sv_maxClients, and uptime, plus a ๐Ÿ”„ Refresh button that pulls fresh numbers. Needs Administrator, and it is the one FiveM command that replies publicly rather than privately.

#/fivem-ban

Bans a player permanently across every identifier FiveUnity knows for them: licence, Discord and anything else recorded when they last played. Needs Ban Members. The player must have joined your server at least once, and the target is their Discord ID rather than a server ID. Each ban creates a record with a Ban ID shown in the reply.

#/kick-id

Kicks a player by their in-game server ID with a required reason. Needs Kick Members.

#txAdmin or the bridge?

They cover different ground, and most servers want both.

Bridge resourcetxAdmin
Give items, cash and bank moneyYesNo
Weather and timeYesNo
Heal, revive, clothing menuYesNo
Chat announcementsYesNo
Player info and inventoryYesNo
Player stats and log sync into DiscordYesNo
Permanent bansNoYes
Kick by in-game server IDNoYes
Live status, player count and uptime embedNoYes
Targets players byDiscord identityServer ID and identifiers
Warning

The bridge cannot ban. Asked to, it would only disconnect the player, and they can reconnect straight away. Permanent bans are the reason to connect txAdmin.

The two are independent: txAdmin commands keep working while the bridge is down, and bridge commands keep working while txAdmin is unreachable.

#Troubleshooting

What you seeWhat it means
txAdmin Integration is not configured.The URL or the password is missing. Both are required: a URL alone does nothing.
Invalid txAdmin credentials.txAdmin answered 401 or 403: it rejected the token in the password field. Paste the current one again.
Received HTML response (likely login page) instead of JSON. Check URL/Auth.The address answered with the txAdmin web interface rather than the token API. Check the URL and port, and that your txAdmin accepts the token header (see the warning above).
txAdmin Logic Error: โ€ฆtxAdmin answered but refused the action and gave a reason, which is quoted in the reply.
Connection Error: โ€ฆtxAdmin could not be reached within 5 seconds. Check the URL and port, that txAdmin is running, and that its port is open to the internet.
txAdmin URL resolves to a private or blocked range.Turn on Allow private / LAN addresses on the FiveM page, or use a public address.
No linked FiveM account found for Discord ID โ€ฆOnly affects /fivem-ban. The player has never joined your server, so there are no identifiers to ban. Nothing was applied.
Tip

If /dashboard fails but /fivem-ban works (or the reverse) the credentials are fine and the problem is with that specific txAdmin feature. If everything fails the same way, it is the URL or the token.