Skip to content
On this page

Docs / Getting started

Install the desktop app

The desktop app is the CLI with a window around it. It runs on the machine your server lives on, pairs it with your workspace, and takes backups without a terminal.

Download and install

Windows 10 and 11, 64-bit. Run the installer on the machine the FiveM server runs on, not on your laptop: backups read the files and the database from that box.

If Windows SmartScreen stops the installer, choose More info, then Run anyway. The command-line tool is installed alongside the app, so you can use either.

Pair the machine

On first run the app shows six characters. An owner or admin types them under Machines in the panel, and the app collects its own credential. Nothing listens on the machine: it dials out to us.

Point it at your server

Choose the server.cfg. The app reads the database connection, the resource folders and the agent key out of it, and claims that server in your workspace.

Set the backup key

Backups are sealed on the machine before they leave it. The app asks for a recovery phrase once. We store a fingerprint, never the phrase: without it nobody, us included, can open a snapshot.

Back up and restore

Back up now takes a full snapshot: database, then files. Restores go the other way, and a restore always takes a preflight snapshot first, so the state you are replacing is never the last copy.

Keep it running in the background

Turn on background backups and the app installs a scheduled task. It wakes every five minutes, checks whether the schedule is owed a snapshot, and runs it even with the window closed.

Windows
Task Scheduler: FiveDock Watch, every 5 minutes.

Updates

The app checks for a new version on launch and installs it itself. You do not need to download the installer again.

On Linux

There is no desktop app for Linux. Everything it does, the command-line tool does too: Install the CLI.