Skip to content

Installation Guide

System Requirements

  • Windows 10 or later (for Windows users)
  • Ubuntu 20.04 or later (for Linux users)

Game Server Hosting Installation

  1. Upload all files and folders from the server-data folder to your game hosting main folder

  2. Modify the database name in your SQL file:

    sql
    CREATE DATABASE IF NOT EXISTS `your_database_name` /*!40100 DEFAULT CHARACTER SET utf8 COLLATE utf8_general_ci */;
    USE `your_database_name`;

    Replace your_database_name with the database name provided by your hosting panel

  3. Database Setup:

    • Get database credentials from your game server hosting panel
    • Download and install HeidiSQL
    • Connect to your database using the hosting-provided credentials
    • Import the ServerDatabase.sql file
  4. Configure server.cfg:

    • Update mysql_connection_string with the connection string from your hosting panel
    • Ensure onesync infinity is enabled
  5. Start your server and connect

Local Installation

Windows Installation

Database Setup

  1. Download and install required software:

  2. Configure Database:

    • Start XAMPP and enable MySQL service
    • Open HeidiSQL and create a new connection
    • Import ServerDatabase.sql file
    • Note: If you change the database name, update it in server.cfg

Server Configuration

  1. Server Setup:

    • Open CFX-files folder
    • Run FXServer.exe
    • Follow browser setup wizard
    • At step 3, select "Local Server Data"
    • At step 4, set server-data folder path
  2. Configure Keys:

    • Open server.cfg in server-data folder
    • Add required keys:
      set steam_webApiKey "YOUR_STEAM_KEY"
      sv_licenseKey "YOUR_LICENSE_KEY"
    • Get license key from keymaster
    • Get Steam Web API key from Steam
  3. Final Setup:

    • In txAdmin settings, set Onesync to Infinity
    • Save settings and restart server

Linux Installation

Database Installation

  1. Update System:

    bash
    sudo apt-get update
  2. Install MariaDB:

    bash
    sudo apt-get install mariadb-server
    sudo mysql_secure_installation
  3. Create Admin User:

    sql
    CREATE USER 'user1'@'%' IDENTIFIED BY 'password1';
    GRANT ALL PRIVILEGES ON *.* TO 'user1'@'%' IDENTIFIED BY 'password1';
    FLUSH PRIVILEGES;

Configure Remote Access

  1. Edit MariaDB Configuration:

    bash
    sudo nano /etc/mysql/mariadb.conf.d/50-server.cnf

    Change bind-address to: bind-address = 0.0.0.0

  2. Restart MariaDB:

    bash
    sudo systemctl restart mariadb
  3. Open Required Port:

    bash
    sudo iptables -A INPUT -p tcp --dport 3306 -j ACCEPT

Server Setup

  1. Download Artifacts:

    bash
    wget https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/14583-b4e669b9a0e75a1050780b6e86603a3e65b442fc/fx.tar.xz
    tar -xf fx.tar.xz
  2. Run Server:

    bash
    ./run.sh

Post-Installation

  1. Configure permissions in permission.cfg
  2. Test server connection
  3. Configure additional server settings as needed

Troubleshooting

Common issues and solutions:

  1. Database Connection Issues:

    • Verify database credentials
    • Check if MySQL/MariaDB service is running
    • Confirm port 3306 is open
  2. Server Start Issues:

    • Verify all paths in server.cfg
    • Check if required ports are open
    • Review txAdmin logs for errors

RedM Server Documentation by RedMScript