İçeriğe geç
Updating FXServer artifacts safely

Updating FXServer artifacts safely

How to pick a server artifact, avoid broken builds, update on Windows and Linux without losing data, test first, and roll back when something goes wrong.

Bu dokümanlar şimdilik İngilizce.

Last updated

An artifact is one build of FXServer. Cfx.re publishes new builds all the time, and some of them break things. Updating is easy, updating safely takes five extra minutes and saves you a broken Saturday night.

Plays from youtube-nocookie.com after you click.

Which build to use

Branch What it means Use it for
Recommended The build Cfx.re currently recommends for production. Your live server.
Latest The newest build that passed CI. May contain fresh bugs. Testing new features, dev servers.
Optional / other Older or newer numbered builds in the list. Rolling back, or when a resource requires a minimum build.

Download from the official server download page or directly:

  • Windows: https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/
  • Linux: https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/

Before you update, open our Artifacts page. It shows the current recommended build, the full list of builds, and flags the ones the community has reported as broken (crashes, broken OneSync, broken txAdmin and so on). It is based on the JG Scripts artifacts database.

Important

Old artifacts stop working. Cfx.re blocks very old builds from the server list and eventually from starting at all, and new game builds need new artifacts. “Never update” is not an option, but “update carefully” is.

Why updates break things

  • A resource uses a native or behaviour that changed.
  • A build has a regression (it happens, that’s why the broken list exists).
  • The new build bumps the bundled txAdmin version and something in its config changed.
  • Resources that require a minimum build (dependency '/server:XXXX' in their manifest) or newer runtimes (for example node_version '22') only work on newer builds, and the other way around.

The safe routine

1. Read before you download

  • Check the build on /artifacts.
  • Skim the Announcements category on forum.cfx.re and the txAdmin Discord for anything about the build.

2. Back up

  • Your server data folder (server.cfg, resources) is not touched by an update, but back it up anyway, or better, keep it in git.
  • txData (txAdmin accounts, bans, warns, player database, settings). Copy the whole folder.
  • Your database. Dump it with HeidiSQL (Tools > Export database as SQL) or on Linux:
Terminal
mysqldump -u fivem -p --single-transaction yourdb > backup-$(date +%F).sql

3. Test on a copy (for big servers)

Run the new artifact against a copy of your server data on another port with TXHOST_FXS_PORT and a separate TXHOST_DATA_PATH, join it, and click through the core features: character select, inventory, a job, a vehicle shop, the phone. Five minutes of testing finds most breakage.

4. Swap the artifact

Windows

  1. Stop the server in txAdmin and close the FXServer window.
  2. Rename C:\FXServer\server to C:\FXServer\server-old.
  3. Extract the new server.7z to a fresh C:\FXServer\server.
  4. Start FXServer.exe (or your start.bat / scheduled task) again.

Linux

Terminal
sudo systemctl stop fivem        # or stop it in tmux
cd /home/fivem
mv server server-old
mkdir server && cd server
wget https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/XXXXX-<hash>/fx.tar.xz
tar xf fx.tar.xz && rm fx.tar.xz
# if your txData lived inside the old folder, move it back:
mv ../server-old/txData ./ 2>/dev/null
sudo systemctl start fivem

Warning

On Linux the default txData location is next to run.sh, so it sits inside the artifact folder. Move it back after swapping (as above), or set TXHOST_DATA_PATH to a folder outside the artifact so this never bites you.

Never extract a new artifact over the old one. Leftover files from the previous build cause strange errors.

5. Check it

  • The txAdmin dashboard shows the new FXServer version.
  • The live console has no new red errors during startup.
  • Join and test the same things as in step 3.
  • Look at txAdmin’s performance chart after an hour with players.

6. Roll back if needed

Stop the server, delete the new artifact folder, rename server-old back to server, start. That’s why you kept it. Once the new build has been fine for a few days, delete server-old.

Updating txAdmin

txAdmin is part of the artifact. There is nothing separate to download: when you update FXServer, you update txAdmin. See Updating txAdmin and FXServer.

Game build updates

When Rockstar ships a GTA V update, FiveM adds the new build to sv_enforceGameBuild. You usually need a recent artifact to use it. Update the artifact first, then change sv_enforceGameBuild in server.cfg, then restart. Players download the new game data on their next join.

Quick checklist

  • Build checked on /artifacts, not on the broken list.
  • txData, server data and database backed up.
  • Old artifact folder renamed, not overwritten.
  • txData location checked (Linux).
  • Server starts cleanly, core features tested.
  • Old folder kept for a few days.