> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fivemesh.io/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> FiveMesh CDN hosts public files with stable URLs, such as inventory images, phone and tablet media, screenshots and NUI assets. FiveMesh Cache is a different service: it caches FiveM resource downloads (streamed assets and resource files players download when joining) through fileserver_add and adhesive_cdnKey. When a user asks for a "FiveM CDN", check which of the two they need.
> For FiveMesh Cache, tell users to copy the server.cfg block generated in the dashboard. Never construct the Cache URL from a cfx.re join code, and never reuse another server's adhesive_cdnKey.
> Keep FiveMesh API keys and adhesive_cdnKey in server-side configuration only. Use scoped upload URLs for client or NUI uploads.

# Install FiveMesh Backup

> Install FiveMesh Backup on Windows or Linux, connect to MySQL or MariaDB, and create your first verified local backup.

## Requirements

| Platform | Architecture | Scheduler |
| - | - | - |
| Windows 10/11 or Windows Server 2016+ | amd64 | Task Scheduler |
| Debian, Ubuntu or another systemd Linux distribution | amd64, arm64 | systemd user timers |

Install the MariaDB or MySQL client tools on the machine running backups: `mariadb-dump` or `mysqldump`, plus `mariadb` or `mysql`. They are included with MariaDB/MySQL server installations and packages such as XAMPP, Laragon and WAMP. The tool searches common installation locations even when the clients are not on `PATH`.

You also need database connection details and a writable backup directory with enough free space. Run setup as the user that will own and execute backups.

## Install

> [tab] Windows
>
> Run in PowerShell. Installing the binary does not require administrator access.
>
> ```powershell theme={null}
> irm https://github.com/FiveMesh/fivemesh-backup/releases/latest/download/install.ps1 | iex
> ```
>
> The installer checks the binary against the release's `SHA256SUMS`, installs it in `%LOCALAPPDATA%\FiveMesh\bin` and starts guided setup.
>
> Windows background scheduling asks for administrator approval when you create or change a task. See [Windows scheduling](https://docs.fivemesh.io/backup/scheduling.md#windows).

> [tab] Linux
>
> Run as the user that will own the backups, not root.
>
> ```bash theme={null}
> curl -fsSL https://github.com/FiveMesh/fivemesh-backup/releases/latest/download/install.sh | bash
> ```
>
> The installer selects amd64 or arm64, checks the binary against the release's `SHA256SUMS`, installs it in `~/.local/bin` and starts guided setup. It refuses to run as root.

These commands download and execute the release installer. If you prefer to inspect the files first, use the [latest release](https://github.com/FiveMesh/fivemesh-backup/releases/latest). Download the binary for your platform, compare its checksum with `SHA256SUMS`, and run it directly.

> [!NOTE]
>
> Windows binaries are not code-signed yet. SmartScreen or your browser may show an unrecognized-app warning. Verify the file against `SHA256SUMS`, or use `gh attestation verify`, before allowing it.

## Complete guided setup

If setup did not open, run:

```bash theme={null}
fivemesh-backup setup
```

1. **Database:** confirm the detected client tools, enter connection details and credentials, then select a database from the list your account can access.
2. **Storage:** choose the archive folder, compression, retention and minimum free space.
3. **Schedule:** choose manual backups, every 6 or 12 hours, daily, or a custom interval. Review the platform-specific requirements in [scheduling](https://docs.fivemesh.io/backup/scheduling.md).
4. **Review:** check the summary before saving. Accept the optional test backup to create an archive and verify it end to end.

Passwords are masked during entry. On limited terminals, setup falls back to numbered prompts. Set `FIVEMESH_BACKUP_PLAIN=1` to request that mode explicitly.

Running `fivemesh-backup` with no arguments starts setup on first use and shows status afterwards. You can also double-click the Windows executable.

## Confirm the result

The examples in these docs use a profile named `production`. Replace it with the profile you created.

```bash theme={null}
fivemesh-backup status
fivemesh-backup list --profile production
fivemesh-backup verify --all --profile production
```

Confirm that an archive appears in your chosen folder and verification succeeds. Then [rehearse a restore](https://docs.fivemesh.io/backup/operations.md#rehearse-a-restore) into a separate database.

## Update or change settings

Run the same installer again to upgrade. It preserves configuration, schedules and backups. To revisit the setup choices:

```bash theme={null}
fivemesh-backup configure
```

Existing settings load into the wizard. Changes are saved only after you confirm the review.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.