Installing and Setting Up Your FiveM Server Template

Make sure you have the following ready:

1. Your FiveMX Server Template: Downloaded from your FiveMX.com account.

2. Server Hosting (see our comparison): A place to run your server. This can be:

   • VPS (Virtual Private Server) or Dedicated Server: Recommended for public servers. Providers like Zap-Hosting (often partners with FiveM), OVH, Hetzner, or Contabo are popular choices. Ensure it meets FiveM's recommended specs (check Cfx.re docs for current recommendations).

   • Windows PC (Local Host): Suitable for testing or playing with friends locally, but usually not powerful or reliable enough for a large public community.

3. FiveM Server Artifacts: The core FiveM server files (for Windows). - If on Linux, Click here

4. Database Software: MySQL or MariaDB (MariaDB is generally recommended as a drop-in replacement for MySQL).

5. Database Management Tool: HeidiSQL (Free, Recommended), phpMyAdmin (Web-based), or MySQL Workbench.

6. Text Editor: A good text editor like Visual Studio Code (Free, Recommended), Notepad++, or Sublime Text. Avoid Windows Notepad as it can mess up file encodings.

7. FiveM License Key: Obtainable from the FiveM keymaster

8. (Windows) Visual C++ Redistributable: The latest version is crucial. Download from Microsoft's official site.

Step 1: Downloading Your Server Template

This is the easiest part!

1. Log in to FiveMX.com: Access your account on our website.

2. Navigate to Downloads: Find the "My Account" or "Downloads" section.

3. Download Your Purchase: Locate the server template you bought and click the download button. It will arrive as a .zip archive. Save it somewhere easily accessible, like your Desktop or a dedicated "FiveM Server" folder.

Important: The server files that you bought are also sent to you via email (link)!

Step 2: Preparing Your Server Environment

This step is crucial for a smooth installation. Don't skip it!

1. Set Up Your Base FiveM Server:

   • Download Artifacts: Go to the official FiveM documentation (docs.cfx.re) and find the link for the latest recommended server artifacts for your operating system (Windows or Linux). Download these.

   • Create Server Directory: Create a main folder for your server (e.g., C:FXServer or /home/user/FXServer).

   • Extract Artifacts: Extract the downloaded server artifacts directly into this folder.

   • Create server-data Directory: Inside your main server directory, create a sub-folder named server-data. This is where your resources and configuration will live, keeping things organized and separate from the core server files. Our template files will go inside this server-data folder.

2. Install Database Software (MySQL/MariaDB):

   • Why? FiveM servers, especially roleplay servers using frameworks like ESX or QBCore, rely heavily on databases to store persistent data: player accounts, character information, inventory, vehicle ownership, business statuses, logs, etc. Without a database, none of this information can be saved between sessions.

   • How?

     • Windows: Download the MySQL Community Server installer or MariaDB installer from their official websites. Follow the installation wizard. During installation, securely note down the root password you set.

     • Linux (Debian/Ubuntu): Use the package manager: sudo apt update && sudo apt install mariadb-server. Run sudo mysql_secure_installation afterwards to set the root password and secure the installation.

     • Linux (CentOS/RHEL): Use the package manager: sudo yum update && sudo yum install mariadb-server. Start the service sudo systemctl start mariadb and enable it on boot sudo systemctl enable mariadb. Run sudo mysql_secure_installation.

   • Verification: Ensure the database service is running (services.msc on Windows, sudo systemctl status mariadb on Linux).

3. Install Database Management Tool (HeidiSQL Recommended):

   • Why? While you can manage MySQL/MariaDB via the command line, a graphical tool makes creating databases, importing data, and browsing tables much easier.

   • How? Download HeidiSQL from its official website and install it. It's lightweight and user-friendly.

4. (Windows Only) Install Visual C++ Redistributable:

   • Why? Many FiveM resources, and FiveM itself, rely on Microsoft's Visual C++ libraries. Missing these is a very common cause of server startup failures or script errors.

   • How? Download the latest x64 version directly from Microsoft and run the installer. Restart your machine if prompted.

Step 3: Installing the Server Template

Now we merge the downloaded template with your prepared server environment.

1. Extract the Template Files:

   • Open the .zip file you downloaded from FiveMX.com.

   • Extract its entire contents directly into the server-data folder you created in Step 2.

   • Crucial: Ensure the file structure is correct. You should see folders like resources and potentially files like server.cfg directly inside server-data, not nested within an extra folder named after the template (e.g., NOT server-data/MyTemplateName/resources, but server-data/resources).

2. Set Up the Database:

   • Locate the SQL File: Inside the extracted template files (likely within the main server-data directory or a dedicated _INSTALL folder), find the database file. It usually ends with .sql (e.g., database.sql, install.sql, esx_legacy.sql).

   • Open HeidiSQL (or your tool): Launch your database management tool.

   • Connect to Database: Create a new connection session.

     • Hostname/IP: 127.0.0.1 (or localhost) if the database is on the same machine as HeidiSQL. If your database is hosted elsewhere, use its IP address.

     • User: root (or the specific user you created, though root is fine for local setups).

     • Password: The password you set during MySQL/MariaDB installation.

     • Port: Usually 3306.

     • Click "Open" or "Connect".

   • Create the Database:

     • Right-click in the left-hand pane (where server connections are listed) or go to the "Query" tab.

     • Execute the command: CREATE DATABASE IF NOT EXISTS your_database_name; (Replace your_database_name with a name you choose, e.g., fivemx_server. Remember this name!). Use a descriptive name. Press F9 or click the "Run" button.

     • Refresh the database list (F5). You should see your new, empty database.

   • Import the SQL File:

     • Select your newly created database in the left pane to make it active.

     • Go to File -> Run SQL file....

     • Navigate to and select the .sql file from your template.

     • Click "Open". HeidiSQL will execute all the commands within the file, creating the necessary tables and potentially inserting default data required by the template's scripts. This might take a few seconds to a minute depending on the template's complexity. Check the log output at the bottom for any errors.

3. Configure Database Connection in Server Files:

   • Why? Your FiveM server needs to know how to connect to the database you just set up. The template includes scripts that require these credentials.

   • Find the Config: The exact location varies between templates and frameworks (ESX, QBCore). Common places include:

     • Directly in server-data/server.cfg.

     • In a specific resource's config file, like server-data/resources//es_extended/config.lua or server-data/resources//qb-core/config.lua.

     • Sometimes in a dedicated database connection script like ghmattimysql or oxmysql. Check the template's documentation or server.cfg for start or ensure lines related to mysql async/oxmysql.

   • Edit the Settings: Open the relevant file(s) with your text editor (VS Code, Notepad++). Look for lines similar to this (syntax might vary slightly between Lua/JS/JSON):

     -- Example for ESX/QBCore style Lua configs
     Config.MySQLConnection = "mysql://root:YourPassword@127.0.0.1/your_database_name?charset=utf8mb4"
     -- or separate fields:
     set mysql_connection_string "server=127.0.0.1;database=your_database_name;userid=root;password=YourPassword;" -- Often found directly in server.cfg for older setups or specific resources
     -- or in JSON format for some resources:
     // { "host": "127.0.0.1", "user": "root", "password": "YourPassword", "database": "your_database_name" }
     

      

   • Update Values: Replace "YourPassword" with your actual database root password and "your_database_name" with the exact database name you created in HeidiSQL. Ensure the host (127.0.0.1 or localhost) and user (root) are correct.

   • Save the file(s). Double-check you've updated all necessary connection strings if there are multiple.

4. Review and Configure server.cfg:

   • Open the server-data/server.cfg file with your text editor. This is the main configuration file for your FiveM server.

   • Essential Settings:

     • sv_licenseKey "your_license_key": Replace "your_license_key" with the key you generated from the FiveM Keymaster. This is mandatory for the server to be listed and function correctly.

     • sv_hostname "My Awesome FiveMX Server": Change this to your desired server name as it will appear in the server list. Use colors and emojis if you like (using ).

     • sv_maxclients 48: Set the maximum player slots (ensure your license type supports this number – standard keys support up to 48, higher tiers via Patreon).

     • sv_projectDesc "A description of my server.": Set a short description that appears in some server lists or details panels.

     • sets steam_webApiKey "YOUR_STEAM_API_KEY": Required for many frameworks/scripts. Obtain one from the Steam Developer website. Add this line if it's missing and required by your framework.

     • ensure ...: These lines load your resources. The FiveMX template should have these pre-configured. The order can sometimes matter, especially for frameworks (e.g., ensure es_extended before ESX addons). Don't change the order unless you know what you're doing or following specific instructions.

   • Review Other Settings: Look through the file for any other settings specific to the template (like locale, starting money, script-specific convars) and adjust as needed. Comments (# or -- at the start of a line) often explain what settings do.

   • Save the server.cfg file.

Done for now.

Step 4: Starting Your Server

Time to bring it online!

• Navigate to the Correct Directory: Open your server's main directory (e.g., C:FXServer or /home/user/FXServer), the one containing the FXServer.exe or run.sh file, NOT the server-data directory.

• For Windows Users:

  1. Find run.cmd or similar: Look for a batch file typically named run.cmd or sometimes start.bat. Often it will reference the server-data directory, like +exec server.cfg +set txAdminPort 40120.

  2. Double-Click: Double-click the run.cmd (or equivalent) file.

  3. Console Window: A command prompt window (or multiple, if using TxAdmin) will appear. This is your server console. Watch it closely!

• For Linux Users:

  1. Open Terminal: Open a terminal window in your main server directory.

  2. Make Executable (if needed): Ensure the start script is executable: chmod +x run.sh.

  3. Run the Script: Execute the start script: ./run.sh +exec server.cfg. (The +exec server.cfg part might already be inside the run.sh script itself).

  4. Console Output: The server console output will appear directly in your terminal.

Verify the Server is Running:

• Watch the Console: Look for messages indicating resources are starting (often green text like Started resource MyResource).

• Check for Errors: Critically look for RED error messages. Common errors include:

  • Authentication failure: Could not connect to database. (Check Step 3.3 - Database Credentials).

  • Could not find resource X. (Check if the resource folder exists in resources and the ensure X line in server.cfg matches the folder name exactly).

  • Script ERROR: ... (Indicates a problem within a specific script's code. May require debugging or checking for compatibility issues).

  • Errors related to missing dependencies (like the Visual C++ Redistributable on Windows).

• Success Message: Ideally, after loading all resources, you'll see messages indicating the server is up, listening on a port, and authenticated with FiveM services.

• Connect In-Game:

  1. Launch FiveM on your gaming PC.

  2. Press F8 to open the client console.

  3. Type connect 127.0.0.1:30120 (if running the server on the same machine you're playing on) or connect YOUR_SERVER_IP:30120 (if the server is hosted elsewhere, use its public IP address). The default port is 30120 unless changed in your startup script or server.cfg.

  4. If everything is correct, you should start connecting to your server!

Step 5: Basic Customization (Post-Install)

Your server is running, but now you want to make it yours.

• Backup First! Before making major changes, stop the server and make a backup of your server-data folder and your database (use HeidiSQL's export feature).

• Change Logos/Loading Screens: Look for resources related to visuals (e.g., loadingscreen, scoreboard) and check their html, css, js files or config.lua for customization options. Replace image files (like logo.png) with your own, keeping dimensions similar.

• Configure Jobs/Activities: Explore the configuration files (config.lua is common) within specific resource folders (e.g., resources//policejob/config.lua) to adjust job payouts, locations, required ranks, etc.

• Add/Remove Vehicles: To add custom vehicles, you typically place the vehicle resource folder into your resources directory and add ensure vehicle_resource_name to your server.cfg. Consult guides specific to adding vehicles. Removing is the reverse (delete folder, remove ensure line).

• Tweak Economy: Framework configs (ESX/QBCore) often control starting cash, salary intervals, and base item prices. Adjust these carefully.

Step 6: Managing and Maintaining Your Server

Running a server is an ongoing process:

• Regular Backups: Seriously, automate this if possible. Back up your server-data folder (especially the resources subfolder and server.cfg) and your database (.sql dump) daily or at least several times a week. Store backups off-site if possible. Check out our dedicated backup tutorial !

• Stay Updated:

  • FiveM Artifacts: Periodically check the FiveM documentation for new recommended server builds and update your core server files (usually involves replacing the files outside server-data). Read changelogs first!

  • FiveMX Template Updates: Keep an eye on FiveMX.com for updates to your specific template. Updates might include bug fixes, new features, or compatibility improvements. Follow our update instructions carefully.

  • Resource Updates: Individual script creators often update their resources on platforms like GitHub. Updating requires replacing the resource folder and checking for configuration changes. Be cautious, as updates can sometimes break things or conflict with other scripts.

• Monitor Performance: Use server monitoring tools (like txAdmin included with FiveM, or resource monitors like htop on Linux / Task Manager on Windows) to check CPU/RAM usage. High usage might indicate poorly optimized scripts.

• Engage with Your Community: Listen to player feedback for bug reports and suggestions.

• Use Support Channels: If you encounter issues related to the FiveMX template itself, don't hesitate to use our Discord or support forums.

Troubleshooting Common Issues

Problems happen. Here’s how to approach them:

1. Server Won't Start / Crashes Immediately:

   • Check Console: Scroll up in the server console window/log file. Look for the first error message. This often points to the root cause.

   • Check server.cfg: Syntax errors (missing quotes, commas), incorrect license key.

   • Database Connection: Double-check credentials in config files (Step 3.3). Ensure MySQL/MariaDB service is running.

   • Missing Dependencies: (Windows) Reinstall Visual C++ Redistributable. Ensure all required base resources (like mysql-async or oxmysql, es_extended, qb-core) are present and started before dependent resources in server.cfg.

   • Port Conflict: Ensure no other application is using port 30120 (or whichever port you configured).

2. Can't Connect / Connection Refused:

   • Server Running? Double-check the console to ensure the server finished starting without critical errors.

   • Firewall: Ensure your server's firewall (Windows Firewall, ufw on Linux, or your hosting provider's firewall) allows incoming TCP and UDP traffic on port 30120 (and 30110 if using server list features, plus TxAdmin port if used e.g. 40120).

   • Correct IP/Port: Are you using the correct public IP address and port in the FiveM client? (Use 127.0.0.1 only if connecting from the same machine).

   • ISP Port Blocking: Some residential ISPs block ports commonly used for hosting.

3. Resources Not Loading / Errors In-Game:

   • Console Errors: Check the server console (F8 console in-game often shows client-side errors, but server console shows loading issues). Look for Could not find resource or Script ERROR related to specific resources.

   • ensure Name: Ensure the name in server.cfg (ensure resource_name) exactly matches the folder name in the resources directory (case-sensitive on Linux!).

   • Dependencies: Did you forget to ensure a required resource before the one that's erroring? (e.g., trying to use an ESX function before ensure es_extended).

   • Database Tables Missing: If scripts complain about nil values or unknown tables, your database import might have failed, or the script expects tables that weren't included. Check the script's documentation.

• Need More Help? Check out our detailed troubleshooting section.

Server Installed - What Now?

Congratulations! You've successfully installed and launched your FiveM server using a FiveMX template. The foundation is laid.

Now the real fun begins: customizing the details, inviting players, building your community, and creating unique experiences.

Remember that server ownership is a learning process. Don't be afraid to experiment (with backups!), consult documentation (FiveM's, script-specific, and ours), and engage with the wider FiveM and FiveMX communities.

Launch faster

Compare curated bundles

Bundles shorten the path from planning to launch by grouping the highest-leverage scripts into a cleaner commercial starting point.