Install the agora FiveM resource

In short. The agora resource opens the in-game tablet, sends player presence (who plays which character, on duty or not) and takes the photos. It is generated by your site: the address and the secret are already in it.

Before you start #

• Your site has a public address saved (Administration → Configuration → Site identity). Without it, the resource refuses to be generated: the download answers "Hub address unknown: the resource would not know where to write…" instead of giving the zip.
• The site is on https, or reachable at an address of your local network. See config.lua and the secret.
• OneSync is on for your server (ESX Legacy, recent QBCore and Qbox already require it).

Method 1 — Through the panel (recommended) #

You need the panel connected in Server → Panel and Detect the configuration run once (see Console, panel and database).

1. Administration → Configuration → Agora resource, Installation block, Deploy through the panel card (marked Recommended). The same button exists in Server → Panel, Automatic deployment block.
2. Click Deploy through the panel.

Agora uploads the files to resources/agora, adds ensure agora (and its restart permissions) to server.cfg, then restarts the resource through the path that reaches the game server, with refresh then ensure agora:

• server online: the resource restarts itself on its next presence, or through the panel console;
• server under txAdmin: the panel console does not reach the game server, so Agora tells you to restart through txAdmin (Open txAdmin to restart link);
• server off: the resource starts with it.

The green message offers Restart the resource when the server is connected. It is active as soon as it announces its new version.

Method 2 — Over SFTP #

These fields only show when no panel is connected.

1. Server → Panel, SFTP access to the FiveM server (no panel) block: host, port, user, password or key, resources folder, and the host key fingerprint.
2. Test the SFTP access, then Deploy over SFTP.
3. In the game server console, type refresh then ensure agora (or restart).

Method 3 — By hand #

1. Administration → Configuration → Agora resource, Installation block, Download agora.zip card.

2. Unzip into resources/, keeping the folder name agora.

3. In server.cfg, after your framework (qbx_core, qb-core or es_extended), add:

   Copy

   ensure agora

4. Restart the server, or type refresh then ensure agora.

⚠ Keep the name agora. Under another name, the tablet opens on an empty frame, and the console says so at startup.

What the resource sends #

Only to your site's address, with the shared secret: presence (who is online, with which character, job and rank, and whether they are on duty), positions when the live map is on, portraits and record photos. No loop or periodic request besides presence.

• The rank travels with presence: when the game announces a job or rank change, Agora resyncs the member's rank Discord roles (see Discord roles, sync and "Suspended member"). An older resource only reports the job change: redeploy it after an Agora update.
• The text of one player shown to another (a 911 description for officers, a character name or failure reason in chat) is cleaned before display: tags (<, >) and control characters removed, since some notification systems and chat forks render HTML.

Check #

1. In the game server console, look for the line [agora] v0.3.3 — presence every 30 s — framework: … then [agora] presence: connected to Agora.
2. In Agora, Server → Players, Game server box: "Last signal from the agora resource: a few seconds ago".
3. In game, type /agora or press F2.

If nothing happens: Troubleshoot the resource.