FiveM server can be setup on Windows VPS or Linux VPS plans.
Javapipe recommends the Linux option since it uses less resources, can handle more traffic and easily mitigate DDoS attacks.
FiveM on Windows VPS requires the following:
- Visual C++ Redistributable 2019 or newer.
- Git to assure a correct installation.
Installation
-
Create a new folder (for example
D:\FXServer\server). -
Download the latest
masterbranch build for Windows from the artifacts server. -
Extract the build into the directory previously created, using any archiving tool (WinRAR or 7-zip).
-
Clone cfx-server-data in a new folder outside of your server binaries folder, for example,
D:\FXServer\server-data.
4b.git clone https://github.com/citizenfx/cfx-server-data.git server-data -
Make a server.cfg file in your
server-datafolder (copy the example server.cfg file below into that file). -
Generate a license key at https://keymaster.fivem.net.
-
Set the license key in your server.cfg using
sv_licenseKey "your_license_here". -
Run the server from the
server-datafolder. For example, in a plain Windows command prompt (cmd.exe) window:cd /d D:\FXServer\server-data D:\FXServer\server\FXServer.exe +exec server.cfg
FiveM on Linux VPS
- On a new folder (for example
mkdir /home/username/FXServer/server), download the latestmasterbranch build for Linux from the artifacts server (copy the URL for the latest server version and usewget <url>to download it). - Extract the build to the directory that was previously created, using
cd /home/username/FXServer/server && tar xf fx.tar.xz(you need to havexzinstalled, on Debian/Ubuntu this is in thexz-utilspackage). - Clone cfx-server-data in a new folder outside of your server binaries folder.
4b. For examplegit clone https://github.com/citizenfx/cfx-server-data.git /home/username/FXServer/server-data - Make a server.cfg file in your
server-datafolder (copy the example server.cfg file below into that file). - Generate a license key at https://keymaster.fivem.net.
- Set the license key in your
server.cfgusingsv_licenseKey "yourLICENSEhere". - Run the server from the
server-datafolder.
8b.bash /home/username/FXServer/server/run.sh +exec server.cfg
Common issues
- If you don't get any ‘resources found’, and it says ‘Failed to start resource’, you didn't ‘cd’ to the right folder.
- If no resources get started, and you can't connect, you didn't add +exec.
- If you get ‘no license key was specified’, one of the above things applies.
server.cfg
An example server.cfg follows.
# Only change the IP if you're using a server with multiple network interfaces, otherwise change the port only.
endpoint_add_tcp "0.0.0.0:30120"
endpoint_add_udp "0.0.0.0:30120"
# These resources will start by default.
ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure fivem
ensure hardcap
ensure rconlog
ensure scoreboard
# This allows players to use scripthook-based plugins such as the legacy Lambda Menu.
# Set this to 1 to allow scripthook. Do note that this does _not_ guarantee players won't be able to use external plugins.
sv_scriptHookAllowed 0
# Uncomment this and set a password to enable RCON. Make sure to change the password - it should look like rcon_password "YOURPASSWORD"
#rcon_password ""
# A comma-separated list of tags for your server.
# For example:
# - sets tags "drifting, cars, racing"
# Or:
# - sets tags "roleplay, military, tanks"
sets tags "default"
# A valid locale identifier for your server's primary language.
# For example "en-US", "fr-CA", "nl-NL", "de-DE", "en-GB", "pt-BR"
sets locale "root-AQ"
# please DO replace root-AQ on the line ABOVE with a real language! :)
# Set an optional server info and connecting banner image url.
# Size doesn't matter, any banner sized image will be fine.
#sets banner_detail "https://url.to/image.png"
#sets banner_connecting "https://url.to/image.png"
# Set your server's hostname
sv_hostname "FXServer, but unconfigured"
# Nested configs!
#exec server_internal.cfg
# Loading a server icon (96x96 PNG file)
#load_server_icon myLogo.png
# convars which can be used in scripts
set temp_convar "hey world!"
# Uncomment this line if you do not want your server to be listed in the server browser.
# Do not edit it if you *do* want your server listed.
#sv_master1 ""
# Add system admins
add_ace group.admin command allow # allow all commands
add_ace group.admin command.quit deny # but don't allow quit
add_principal identifier.fivem:1 group.admin # add the admin to the group
# Hide player endpoints in external log output.
sv_endpointprivacy true
# enable OneSync with default configuration (required for server-side state awareness)
onesync_enabled true
# Server player slot limit (must be between 1 and 32, unless using OneSync)
sv_maxclients 32
# Steam Web API key, if you want to use Steam authentication (https://steamcommunity.com/dev/apikey)
# -> replace "" with the key
set steam_webApiKey ""
# License key for your server (https://keymaster.fivem.net)
sv_licenseKey changeme