Server Setup

Deploy Mythic Framework using the txAdmin Recipe Deployer

This guide covers deploying Mythic Framework to your FiveM server using the txAdmin Recipe Deployer - the easiest and recommended method for all users.

txAdmin Recipe Deployer

The txAdmin Recipe Deployer automatically installs Mythic Framework with all dependencies, database configuration, and proper resource loading order.

What is txAdmin? txAdmin is the official FiveM server management panel. It comes pre-installed with FiveM server builds and provides web-based server management, recipe deployment, and more.

Prerequisites

Before using the recipe deployer, ensure you have:

1. FiveM Server

   Download and install a FiveM server build (txAdmin is included)

   Windows: Download from FiveM Artifacts

   Linux: Download from FiveM Artifacts

2. Database Requirements

   Install required databases on your server:

   • MongoDB (version 4.4 or higher) - For document storage
   • MariaDB/MySQL (version 10.5+ or MySQL 8.0+) - For relational data

   See Database Setup for installation instructions

3. Node.js & pnpm

   Install dependencies for UI resources:

   • Node.js (version 18.x or higher)
   • pnpm (package manager)

   # Install Node.js from https://nodejs.org/
   
   # Install pnpm globally
   npm install -g pnpm
   

Recipe Deployment Steps

1. Start txAdmin

   Launch your FiveM server with txAdmin for the first time:

   Windows:

   # Navigate to your FiveM server directory
   cd C:\FiveMServer
   
   # Start txAdmin
   FXServer.exe
   

   Linux:

   # Navigate to your FiveM server directory
   cd ~/fivem-server
   
   # Start txAdmin
   ./run.sh
   

   txAdmin will provide a setup URL (usually http://localhost:40120)

2. Access txAdmin Panel

   Open your web browser and navigate to the txAdmin URL shown in the console

   First-time Setup:

   1. Create an admin account
   2. Link your FiveM license key (get one at Cfx.re Portal)
   3. You’ll be presented with deployment options
3. Deploy Mythic Framework Recipe

   In the txAdmin deployment screen:

   1. Select “Custom Recipe” or “Remote URL Template”
   2. Enter the Mythic Framework recipe URL:
      https://raw.githubusercontent.com/Mythic-Framework/txAdminRecipe/main/mythic-stable.yaml
      
   3. Click “Next” or “Deploy”
4. Configure Deployment

   The recipe deployer will prompt you for configuration:

   Database Credentials:

   • MongoDB connection string
   • MariaDB/MySQL host, port, username, password, database name

   Server Settings:

   • Server name
   • Max players
   • Server license key
   • Steam Web API key (optional)

   Important: Have your database credentials ready before starting deployment. The recipe will test connections during setup.

5. Wait for Deployment

   The recipe deployer will:

   • Download Mythic Framework resources
   • Install npm dependencies for UI resources
   • Configure server.cfg and database connections
   • Set up resource loading order
   • Initialize database schemas

   This may take 10-15 minutes depending on your internet connection and server specs.

   Watch the deployment log for any errors. Most issues are related to database connectivity or missing dependencies.

6. Verify Installation

   After deployment completes:

   1. Check the txAdmin dashboard shows “Server Online”
   2. Verify resources loaded successfully in the console
   3. Connect to your server via FiveM client
   4. You should see the Mythic Framework loading screen

Post-Deployment Configuration

After successful deployment, you may want to customize:

Server Settings

Edit server.cfg in txAdmin’s file editor or directly:

# Server identity
sv_hostname "My Mythic Server"
sv_maxclients 32

# Server listing
sets tags "mythic, roleplay, economy"
sets banner_detail "https://url-to-your-banner.png"
sets banner_connecting "https://url-to-your-banner.png"

# OneSync (required for Mythic)
set onesync on

Database Connections

Database connections are auto-configured in:

• resources/[mythic]/mythic-base/config.lua (MongoDB)
• resources/oxmysql/config.json (MariaDB/MySQL)

You can update these if your database credentials change.

Resource Order

Resource loading order is automatically set in resources.cfg.

Do not change the order of core Mythic resources - they must load in a specific sequence.

Troubleshooting Recipe Deployment

Recipe URL not found

Error: “Could not fetch recipe from URL”

Solutions:

• Verify the URL is correct: https://raw.githubusercontent.com/Mythic-Framework/txAdminRecipe/main/mythic-stable.yaml
• Check your server has internet access
• Try accessing the URL in a web browser to verify it’s accessible

Database connection failed

Error: “Failed to connect to database”

Solutions:

• Verify database servers are running:
  # Check MongoDB
  mongosh --eval "db.version()"
  
  # Check MariaDB/MySQL
  mysql -u root -p -e "SELECT VERSION();"
  
• Verify credentials are correct
• Check firewall isn’t blocking database ports (27017 for MongoDB, 3306 for MySQL)
• Ensure databases exist and user has proper permissions

npm/pnpm errors during deployment

Error: “pnpm install failed” or “npm ERR!”

Solutions:

• Verify Node.js is installed: node --version (should be 18.x or higher)
• Install pnpm globally: npm install -g pnpm
• Check internet connection for package downloads
• Manually run pnpm install in UI resource directories:
  cd resources/[mythic]/mythic-phone/ui
  pnpm install
  

Resources not loading

Error: Resources show as “failed to load”

Solutions:

• Check resource directories exist in resources/[mythic]/
• Verify resources.cfg was created properly
• Check server console for specific error messages
• Restart txAdmin completely

---

Next Steps

Your server is now deployed via txAdmin! Next steps:

Server Configuration

Configure server.cfg settings and admin permissions

First Start

Start your server and create your first character

Troubleshooting

Common issues and solutions

Database Configuration: The txAdmin recipe automatically configures all database connections. You can proceed directly to server configuration!