Skip to content

Start

Connect your server

Setting up takes a few minutes. You name your server, run one small program on the machine that hosts it, and confirm a few choices in your browser.

Before you start

  • Sign in to SwisserAI and open Server Reports, then Connect your server.
  • Have access to the machine that runs your FiveM server. That is the server itself, not the PC you play on.
  • On Windows you need administrator rights. On Linux, root (sudo) is best but not required.

The seven steps

The setup page shows where you are. It follows your agent live, so you can reload it or open it in a second tab.

  1. Name
  2. Install agent
  3. Installation
  4. 4Database access
  5. 5Data use
  6. 6Meanings
  7. 7Collecting
The seven setup steps. The page moves on by itself as soon as the agent reports back, and you can reopen earlier steps.
  1. 1

    Name

    Give your server a name you recognise. Times in your reports use the time zone of your browser, which the page shows under the field.

  2. 2

    Install agent

    Download the agent for Windows, or copy the command for Linux. Both carry a one-time code that links the agent to this server. The code works once and for 24 hours. See Install the agent below.

  3. 3

    Installation

    The agent looks for FiveM on the machine and shows what it found: the folder, txAdmin, the framework and the database. If it finds more than one server, pick the one you want reports for, then This is my server.

  4. 4

    Database access

    Choose how the agent reads your database. The recommended option creates a separate account that can only read. What the options mean.

  5. 5

    Data use

    Tick what the agent may send. Only what you tick leaves your server. Each option explained.

  6. 6

    Meanings

    We show what we think your data means, for example which value is cash and which is bank money, with a few redacted examples from your own database. If it looks right, press Looks right, start collecting. If you are unsure, press I don't know. Nothing is collected before you confirm.

  7. 7

    Collecting

    The agent reads everything once, then only the changes. On a large server the first read can take a few minutes. After that, press Ask your server.

Install the agent

Pick the system your FiveM server runs on.

  1. 1

    Download the file

    On the Connect page, choose Windows and download the file. Its name looks like SwisserAgent-YOURCODE.exe.

  2. 2

    Copy it to your server machine

    Put the file on the Windows machine that runs FiveM. Keep the file name as it is: the code in the name links the agent to your server.

  3. 3

    Double-click it

    Allow administrator rights when Windows asks. The agent installs itself as a background service and starts. You can close the window when it says so. The Connect page moves on by itself, usually in less than a minute.

At first the agent only reports which FiveM installations it found. Nothing from your database is sent until you allow it in the next steps. Database passwords never leave the machine.

Containers and game panels

Docker and other containers

Most containers have no service manager. Run the Linux command inside the container that runs FiveM, or in one that can see the server folder and reach the database. The agent then runs in the foreground, so keep it running with your container setup or with screen or tmux.

Pterodactyl, ZAP-Hosting and similar

Not supported yet, as described in the Hosted panel tab above. The agent needs to run on the machine that hosts FiveM, and most panels do not allow that.

When it is connected

The last step shows the agent as Online, the database access it uses, what is collected and when data last arrived. From here you can Pause, Change what we collect or start asking questions.

  • Agent

    Online or offline, the last check-in, the agent version and the system.
  • Database access

    Separate read-only account, or your existing connection.
  • Installation

    The server folder and the framework that was recognised.
  • Collected

    The kinds of data you allowed. Kept 30 days.
  • Last data

    When the agent last sent something.

All of this, plus members, alerts and Discord, is also in the server settings. Open them with the gear icon next to your server.