Dedicated server guide

GTA FiveM

Manage gtafivemserver with AlphaGSM. Choose a runtime supported by the recorded module capabilities.

Authentication required · Support evidence: 2026-10-16.

Runtime familysteamcmd-linux

Declared runtimes: Docker or a Linux host process.

Network bindings

30120/UDP, 30120/TCP. Named port values remain unknown; review the game guide and configuration for additional requirements.

Mods and plugins

No mod support is declared in this snapshot; review the game guide before adding mods.

Backup hook

A module-specific backup hook is declared. Review the game guide for its scope, restore procedure and shutdown requirements.

Choose a supported runtime

Linux and Docker quickstart

Authentication is required before installation; follow the game guide for credentials, ownership and login prerequisites.

Docker

Complete interactive setup and review game-specific configuration before starting the server. Authentication is required before installation; follow the game guide for credentials, ownership and login prerequisites.

Start the Docker manager ./alphagsm-docker start
Create the game instance ./alphagsm-docker my-gtafivemserver create gtafivemserver
Complete interactive setup ./alphagsm-docker my-gtafivemserver setup
Start the game server ./alphagsm-docker my-gtafivemserver start
Check the instance status ./alphagsm-docker my-gtafivemserver status

./alphagsm-docker start
./alphagsm-docker my-gtafivemserver create gtafivemserver
./alphagsm-docker my-gtafivemserver setup
./alphagsm-docker my-gtafivemserver start
./alphagsm-docker my-gtafivemserver status

Host process

Create the game instance ./alphagsm my-gtafivemserver create gtafivemserver
Complete interactive setup ./alphagsm my-gtafivemserver setup
Check the host prerequisites ./alphagsm my-gtafivemserver doctor
Start the game server ./alphagsm my-gtafivemserver start
Check the instance status ./alphagsm my-gtafivemserver status

./alphagsm my-gtafivemserver create gtafivemserver
./alphagsm my-gtafivemserver setup
./alphagsm my-gtafivemserver doctor
./alphagsm my-gtafivemserver start
./alphagsm my-gtafivemserver status

This guide covers the gtafivemserver module in AlphaGSM.

gtafivemserver is currently ENABLED (AUTH) on the documented Ubuntu 24.04 Linux baseline. The current GitHub integration lane still exercises both process and Docker runtime selection around the required txAdmin/server-data provisioning plus Cfx license-key flow, while local runs remain process-backed by default unless you opt into the Docker backend.

Requirements

screen
a Cfx.re server license key
operator-managed txAdmin or vanilla server-data provisioning
Python packages from requirements.txt

Quick Start

Create the server:

alphagsm mygtafivem create gtafivemserver

Run setup:

alphagsm mygtafivem setup

gtafivemserver is supported in ENABLED (AUTH) mode. AlphaGSM can download the current Linux FXServer artifact, but you still need to complete one of the supported Cfx provisioning flows before the server is actually ready:

txAdmin first-run provisioning against the downloaded artifact, including browser-based account linking, PIN entry, and recipe/profile creation, or
a pre-staged vanilla server-data/ tree with a valid server.cfg, license key, resources, and any other server configuration you intend to run

Start it:

alphagsm mygtafivem start

Check it:

alphagsm mygtafivem status

Stop it:

alphagsm mygtafivem stop

Setup Details

Setup configures:

the game port (default 30120)
the install directory
downloads and extracts the server archive

Suggested txAdmin-oriented flow:

alphagsm mygtafivem create gtafivemserver
alphagsm mygtafivem setup -n 30120 /path/to/fivemserver
alphagsm mygtafivem start
## complete txAdmin provisioning in the browser against the downloaded artifact

Suggested vanilla/server-data flow:

alphagsm mygtafivem create gtafivemserver
alphagsm mygtafivem setup -n 30120 /path/to/fivemserver
## stage your server-data tree with server.cfg and sv_licenseKey
alphagsm mygtafivem start

Useful Commands

alphagsm mygtafivem update
alphagsm mygtafivem backup

Notes

Module name: gtafivemserver
Default port: 30120
Install mode: ENABLED (AUTH) txAdmin/server-data provisioning

Server variables

After create gtafivemserver, inspect or change these with set:

alphagsm myserver set --list
alphagsm myserver set KEY --describe
alphagsm myserver set KEY VALUE

This module does not declare schema-backed keys. set --list after create is still the live source of truth.

Developer Notes

Run File

Executable: opt/cfx-server/run.sh
Location: <install_dir>/opt/cfx-server/run.sh
Engine: Custom

Server Configuration

Config file: usually server-data/server.cfg for vanilla deployments, or the txAdmin-managed profile under txData/
Template: See server-templates/gtafivemserver/ if available

Maps and Mods

Map directory: Check game documentation
Mod directory: Check game documentation
Workshop support: No

Configuration templates

Reference files from this source revision. Review paths, passwords and game-specific settings before use.

Share your server

Sector Alpha server directory

When your server is ready, you can publish its connection details and community information on Sector Alpha. Review your listing and keep the information current.

Find a community

Browse the directory for game servers and their published connection details.

Browse server directory

Publish your server

Prepare a name, address and description for your listing.

Publish a server

Manual server sharing instructions

Frequently asked questions

What support evidence is recorded for GTA FiveM?

Authentication required. Authentication is required before installation; follow the game guide for credentials, ownership and login prerequisites.

Which runtimes can run GTA FiveM?

Declared runtimes: Docker or a Linux host process.

Which ports does GTA FiveM use?

30120/UDP, 30120/TCP. Named port values remain unknown; review the game guide and configuration for additional requirements.

Can I add mods to GTA FiveM?

No mod support is declared in this snapshot; review the game guide before adding mods.

How should I back up GTA FiveM?

A module-specific backup hook is declared. Review the game guide for its scope, restore procedure and shutdown requirements.

Source and support evidence

This guide mirrors AlphaGSM’s upstream documentation at 32cef5ba9e03053c8e461fffa0ba133b160b528d. Commands and prerequisites can change. Check current support notes before installation.

All game guides