Skip to content

Commit

Permalink
Update txAdmin Docs
Browse files Browse the repository at this point in the history
Updated to match the current version of txAdmin. https://github.com/tabarra/txAdmin/blob/master/README.md
  • Loading branch information
aidenzybell committed May 12, 2021
1 parent cc36b8a commit acc37d0
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions content/docs/resources/txAdmin/_index.md
Expand Up @@ -7,20 +7,22 @@ title: txAdmin
Contrary to the other resources on this documentation (eg. chat, mapmanager and etc), **txAdmin** already comes preinstalled with FXServer, so you do not need to download it separately.

## Main Features
- Recipe-based Server Deployer: create a server in under 60 seconds!
- Start/Stop/Restart your server instance or resources
- Server Performance Chart (all 3 threads) ([example](https://i.imgur.com/VG8hpzr.gif))
- Access control:
- Login via Password or CitizenFX
- Admin permission system ([more info](permissions))
- Action logging
- Login brute-force protection
- Discord Integration:
- Server status command (`/status`)
- Add to Whitelist command (`/addwl`)
- Command spam prevention
- Monitoring:
- Auto Restart on crash
- Auto Restart FXServer on crash
- Server’s CPU/RAM consumption
- Live Console (with log file)
- Hitch Detection statistics
- Live Console (with log file and command history)
- Online players chart
- Server Activity Log (connections/disconnections, kills, chat, explosions and custom commands)
- Player Manager:
Expand All @@ -29,16 +31,17 @@ Contrary to the other resources on this documentation (eg. chat, mapmanager and
- Whitelist system
- Take notes about players
- Keep track of player's play and session time
- Import bans from EasyAdmin, BanSQL, vMenu, vRP, el_bwh
- Self-contained player database (no MySQL required!)
- Real-time playerlist
- Scheduled restarts with warning announcements
- Scheduled restarts with warning announcements and custom events
- Translation Support
- FiveM's Server CFG editor
- Responsive web interface
- Responsive web interface with Dark Mode 😎

## Running (Windows/Linux)
Currently **txAdmin is included in all FXServer builds** above 2401, so to run it for the first time simply do the following:
- Update FXServer to the latest artifact/build (2401 or superior)
Currently **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 `./run.sh`
- Open one of the URLs shown and configure txAdmin

Expand All @@ -49,6 +52,7 @@ txAdmin requires to be launched from *inside* FXServer in monitor mode, to do th
### ConVars
- **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`.

Expand Down

0 comments on commit acc37d0

Please sign in to comment.