a Luminare Development open-source project
luminare.gameserver
Ansible roles that install, configure, update and back up game servers, for FiveM/RedM servers (FXServer).
Roles
| Role | What it does |
|---|
fxserver | Installs a server build checked against its sha256 and runs it as a hardened systemd unit, directly or under txAdmin. Switches builds with one rename, rolls a failed update back and backs up server-data and txData before every switch. |
txadmin | Configures txAdmin through TXHOST_* environment variables and keeps port 40120 closed except for loopback and the sources you list. |
gameserver_observability | Adds the game servers to an existing Prometheus with the exporters, scrape jobs, rules and dashboard of the gameserver-observability pack. |
The playbook luminare.gameserver.gameserver runs fxserver and, with fxserver_mode: txadmin,
txadmin on the group gameservers, one host at a time.
Quickstart
Install the collection from a release tag (needs git on the controller):
ansible-galaxy collection install git+https://github.com/luminare-dev/ansible-collection-gameserver.git,v0.2.0
Copy the example inventory, set your host, replace the CHANGE_ME_ values in
group_vars/gameservers/secrets.yml, encrypt that file and run the playbook:
cp -R ~/.ansible/collections/ansible_collections/luminare/gameserver/examples/inventory ./inventory
ansible-playbook -i inventory luminare.gameserver.gameserver
In txAdmin mode the host needs the nftables layout of
luminare.infra_edge (or an
/etc/nftables.conf that includes /etc/nftables.d/*.nft). The collection is not on Galaxy;
see Installation for the release tarball and requirements.yml.
Supported versions
- ansible-core 2.21 or later, Python 3.12 or later on the controller
- Debian 13 or Ubuntu 24.04 (x86_64) on the managed hosts
- Server build 35245 by default (txAdmin 8.1.1); see the upgrade guide
- Prometheus 2.43 or later for
gameserver_observability
The tests run the roles in Molecule with a fake server build, not a real one.
Documentation
Not affiliated
Not affiliated with or endorsed by Cfx.re, Rockstar Games or Take-Two. FiveM, RedM and FXServer
are named only to describe what this project works with.
Licence
Apache-2.0. The licence covers the code only: the project name, logo, header images
and docs/brand/ are not licensed (see NOTICE).
a Luminare Development open-source project
