⚒️FiveM Installation

This is a comprehensive guide will teach you how to install your FiveM files to your local drive on your machine and run your server.

Requirements for the installation:

1. Git.

2. Visual C++ Redistributable 2019 or newer.

• The requirements have to be installed on the machine.

How to install a FiveM server onto your machine:

1. On your machine, create a new folder on disk C: and name it as you’d like.

   
2. Download the latest recommended version from the windows server artifacts-list.

   
3. Extract the build you downloaded into the folder you first created. (Use WinRAR or 7-Zip)

   
4. Select the folder you have created and right-click on it. Then click on the “Git Bash Here” option.

5. After the command-line has opened, paste the following command inside of it using Shift + Ins. git clone https://github.com/citizenfx/cfx-server-data.git server-data

6. Inside the new folder that got created which is called “server-data”, create a new file and name it “server.cfg”.

7. Copy the example server.cfg from Fivem’s server-documents. And paste it inside of the server.cfg you have created.

   
8. Generate a FiveM license key and Steam API key by following the guides below.

9. Take the license key you have generated and paste it inside of your server.cfg like so: sv_licenseKey paste-your-license-key-here

   
10. Take the Steam API key you have generated by and paste it inside of your server.cfg like so: set steam_webApiKeypaste-your-steam-api-key-here

11. Create a .txt file inside of your server-data folder and paste the lines below inside of it. (Change according to your folder names) cd C:\file-name\server-data C:\file-name\FXServer.exe +exec server.cfg Then save the “.txt” file as a “.bat” file. (Name it however you like)

    

    start.bat
12. Enable the FXServer.exe application through the firewall by following the guide below.

13. Start your server by running the .bat file you have created

How to generate a FiveM license key:

1. Head to keymaster.fivem.net and sign in with your FiveM account.

2. Click on the button that says “New”. Insert a name you would like into the “Label” input. Insert 127.0.0.1 into the “Server IP address” input. Pick your server type in the “Server type” input. Enter Armour Hosting into the "Which server provider are you using?" input?
3. Click on the “Generate” button and copy the key which is located to the right of the label you choose.

How to generate a Steam API key:

1. Head to https://steamcommunity.com/dev/apikey and sign in with your Steam account.

2. Insert your machine IP address the “Domain Name” input.

3. Read and agree to Steam Web API Terms of Use.

4. Copy and paste the key into your server.cfg as described above.

How to enable FXServer.exe through the firewall:

1. Search for “Windows Defender Firewall” in the start menu search bar and open the application.

   
2. Click on “Allow an app or feature through Windows Defender Firewall” and choose “Allow another app…”

   
3. Choose the FXServer.exe from your server folder.

   
4. Check both “Private” and “Public” boxes on the app. (If applicable)

   
5. Choose “OK” and close the window.

Still Having Issues?

If the server is not starting properly with all of the default resources started, make sure you have named your folders the same in the folder name itself and in the path you specified in the “.bat” file. It’s the same for if you cannot start your server and it says “no license key was specified”, if the steps were done right and this error still occurs, make sure you have created and copied your license key correctly. If you are still having issues you can contact us via a ticket on our site. Open a ticket in our Discord Server.