Git Product home page Git Product logo

txadmin's Introduction

txAdmin for FiveM



zap-hosting


txAdmin is a completely free to use, full-featured web panel to Manage & Monitor your FiveM Server remotely, in use by over TEN thousand servers worldwide at any given time.

Main Features

  • Recipe-based server deployer: create a live server in under 60 seconds [learn more].
  • Scheduled restarts with warning announcements and custom events [learn more].
  • Start, stop and restart your server instance or resources.
  • FXServer performance chart for all 3 threads [example].
  • Multi language translation support [learn more].
  • Responsive dark and light mode web interface.
  • FXServer CFG editor.
  • Discord Integration:
    • Add to Whitelist command (/addwl);
    • Server status command (/status);
    • Command spam prevention.
  • Access Control:
    • Admin permission system [more info];
    • Login via password or CitizenFX;
    • Brute-force protection;
    • Action logging.
  • Monitoring:
    • Advanced server activity log for connections, disconnections, kills, chat, explosions and custom commands;
    • Live console with a backend log file and command history;
    • Auto FXServer restart on crash detected;
    • Server’s CPU/RAM consumption;
    • Online players chart.
  • Player Manager:
    • Clean and optimize your database by removing old players, or bans/warns/whitelists;
    • Self-contained player database with backup tool that doesn't require MySQL;
    • Ban imports from EasyAdmin, BanSQL, vMenu, vRP, el_bwh;
    • Player session time management & notes system;
    • Temporary or permanent banning system;
    • Whitelist & warning system.

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

Running [Windows & Linux]

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);
  • Windows: run FXServer.exe / Linux:, run screen ./run.sh;
  • Open one of the URLs shown and configure txAdmin.

After that you could also run the start_<build>_<profile>.bat file created, or call it via cmd/bash if you want to edit the ConVars (ex HTTP port).

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.

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.

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

Installing & Building (NOT RECOMMENDED)

If you want to run it from source, or build it yourself, please do read this.

License, Credits and Thanks

  • This project is licensed under the MIT License;
  • Favicons made by Freepik from www.flaticon.com are licensed under CC 3.0 BY;
  • Warning Sounds (1/2) made by Ultranova105 are licensed under CC 3.0 BY;
  • Special thanks to everyone that contributed to this project, specially the very fine Discord folks that provide support for others;
  • Also thanks to our Discord's sky{something} bot, who will hopefully spare us when he becomes self aware and rebels against humanity.

txadmin's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.