txAdmin is a full featured web panel to Manage & Monitor your FiveM/RedM Server remotely, in use by over 21.000 servers worldwide at any given time.

It's been several years since many servers have requested third-party authentication for their systems to simply have one platform to manage their admins. Now, I also wanted this feature for new projects and started developing this feature!

While I was developing this feature, I asked tabarra some questions and showed them the idea. He simply said that we won't merge this into txAdmin because of the new partnership with R*.

So, this will be a modified version of txAdmin which is always up to date with the original txAdmin and my third-party authentication changes. You can easily use this version, which is never outdated because I will keep this repository updated with the original version and merge changes.

• Go to http://ip:port/login?thirdPartyRedirect=...
• The thirdPartyRedirect is the endpoint that should get the session information. It must be encoded, by just using this tool.

  As an example, we want to authenticate with your custom endpoint, which is http://ip:port/authenticate. http://ip:port/login?thirdPartyRedirect=http%3A%2F%2Fip%3Aport%2Fauthenticate

• After authenticating with CFX.RE or username/password, you will be redirected to your thirdPartyRedirect URL with the session, which is Base64 encoded.

  In our example, it's http://ip:port/authenticate?session=... You can use tools to display the response, which is a JSON pair containing information about the user and the token.

• Third-Party Authentication
• Recipe-based Server Deployer: create a server in under 60 seconds! (more info)
• Start/Stop/Restart your server instance or resources
• Full-featured in-game admin menu:
  • Player Mode: NoClip, God, SuperJump
  • Teleport: waypoint, coords and back
  • Vehicle: Spawn, Fix, Delete, Boost
  • Heal: yourself, everyone
  • Send Announcements
  • Reset World Area
  • Show player IDs
  • Player search/sort by distance, ID, name
  • Player interactions: Go To, Bring, Spectate, Freeze
  • Player troll: make drunk, set fire, wild attack
  • Player ban/warn/dm
• Access control:
  • Login via Password or CitizenFX
  • Admin permission system (more info)
  • Action logging
  • Brute-force protection
• Discord Integration:
  • Server configurable, persistent, auto-updated status embed
  • Command to whitelist players
  • Command to display player infos
• Monitoring:
  • Auto Restart FXServer on crash or hang
  • Server’s CPU/RAM consumption
  • Live Console (with log file, command history and search)
  • Server tick time performance chart with player count (example)
  • Server Activity Log (connections/disconnections, kills, chat, explosions and custom commands)
• Player Manager:
  • Warning system
  • Ban (temporary or permanently) system
  • Whitelist system (Discord member, Discord Role, Approved License, Admin-only)
  • Take notes about players
  • Keep track of player's play and session time
  • Self-contained player database with backup tool (no MySQL required!)
  • Clean/Optimize the database by removing old players, or bans/warns/whitelists
• Real-time playerlist
• Scheduled restarts with warning announcements and custom events (more info)
• Translation Support (more info)
• FiveM's Server CFG editor & validator
• Responsive web interface with Dark Mode 😎

Also, check our Feature Graveyard for the features that are no longer among us (RIP).

txAdmin is included in all FXServer builds above 2524, so to run it for the first time simply do the following:

• Update FXServer to the latest artifact/build (2524 or superior)
• If Windows, run FXServer.exe | If Linux, run screen ./run.sh
• Open one of the URLs shown and configure txAdmin

txAdmin requires to be launched from inside FXServer in monitor mode, to do that, just execute the run.sh or FXServer.exe without any +exec arguments.

• serverProfile: The name of the server profile to start. Profiles are saved/loaded from the current directory inside the txData folder. The default is default.
• txAdminPort: The TCP port to use as HTTP Server. The default is 40120.
• txAdminInterface: The interface to use as HTTP Server. The default is 0.0.0.0.
• txDataPath: The path of the data folder. The default on Windows is <citizen_root>/../txData and on Linux <citizen_root>/../../../txData.
• txAdminVerbose: Set to true to print on the console more detailed information about errors and events. The default is false.

ConVar usage example for different port and profile:

# Windows
./FXServer.exe +set serverProfile dev_server +set txAdminPort 40121

# Linux
./run.sh +set serverProfile dev_server +set txAdminPort 40121

• All PRs should be based on the develop branch, including translation PRs.
• Before putting effort for any significant PR, make sure to join our discord and talk to us, since the change you want to do might not have been done for a reason or there might be some required context.
• If you want to run it from build & source, please do read this.

• This project is licensed under the MIT License;
• "Kick" button icons made by SeyfDesigner from www.flaticon.com;
• Warning Sounds (1/2) made by Ultranova105 are licensed under CC 3.0 BY;
• Announcement Sound made by IENBA is licensed under CC BY 4.0;
• Message Sound made by Divinux is licensed under CC0 1.0;
• Especial thanks to everyone that contributed to this project, especially the very fine Discord folks that provide support for others;