Check the requirements before installing Agora

In short. Four things are mandatory: a place to run Agora, a license key, Internet access and a Discord account. No database needs preparing for Agora itself. <!-- À CONFIRMER : œuf tout-en-un (claude/pg-integre) --> Your game server's database and access to your FiveM server are only needed for the MDT and the tablet.

Before you start #

• You have nothing to install to read this page: you only check that everything is ready.
• A technical word stops you? It is explained in the glossary.
• You do not yet know where to install Agora? Read Choose between Docker, the panel egg and a Node.js server first.

The four mandatory things #

1. A place to run Agora #

Pick one of the three possibilities. Each gives the same product.

• Docker on a VPS (a server rented from a host), a NAS (a network storage box) or a machine of your own. You need Docker Engine and its Compose v2 extension, and access to a terminal on that machine, as root or with sudo. To check, type these two commands: they must answer with a version number, and the second must announce version 2 or later.

  Copy

  docker --version
  docker compose version

  <!-- CAPTURE C-004 -->

  If Docker is not installed, the official site explains how: https://get.docker.com.

• A Pterodactyl or Pelican panel (the website where you manage your game servers) where you can import an egg (a file that tells the panel how to install Agora). You must be a panel administrator for that.

• A "Node.js" server sold by an ordinary game host, if you only have that host's customer panel: Node.js 22 or newer, on an x86-64 processor.

The resources to plan for:

On a panel, the forms ask for memory and disk in MB: 2 GB is entered as 2048 and 10 GB as 10240. <!-- À CONFIRMER : œuf tout-en-un (claude/pg-integre) : avec la base intégrée, 2 Go de mémoire sont conseillés -->

<!-- CAPTURE C-006 -->

2. A license key #

The key is read on the very first start: without it, nothing is downloaded. The 14-day trial is a key too, free, to get from your space on agorapanel.com. See The 14-day free trial.

3. Outbound HTTPS access #

Your machine must be able to reach these addresses on the Internet (this is called outbound access: the machine calls out, nobody needs to call it):

• the license and update server: lic1.agorapanel.com and lic2.agorapanel.com;
• agorapanel.com (bootstrap and map backgrounds);
• discord.com (member sign-in and bot).

To check from your machine, type this command: an HTTP answer, whatever it is, proves the connection goes through.

curl -sI https://lic1.agorapanel.com/ | head -n 1

<!-- CAPTURE C-005 -->

4. A Discord account #

Agora has no accounts of its own: every sign-in goes through Discord. You create a Discord application (a small object you declare in Discord's developer portal) during the getting-started setup; the screen guides you. You only need a Discord account. See Connect Discord.

What is optional #

• A domain name (an address such as forum.myserver.com): it is not required. An http://IP:PORT address is enough to install and run Agora. Still, plan for HTTPS as soon as the server leaves testing: the in-game tablet and installing the site as an app need it.
• Your game server's database, for the MDT: it is the MySQL or MariaDB database your FiveM server (ESX, QBCore or Qbox) already uses. The forum, applications and donations work without it; the MDT, live map, HR and dealership need it, reachable from the Agora machine. Do not mix it up with Agora's own database: see The two Agora databases and Connect the game server database.
• Access to your FiveM server, for the tablet: your panel's API key, SFTP access (a secure file transfer), or simply your host's file manager.

Players #

• A Discord account linked to FiveM (Discord identities enabled on the server).
• Nothing to install: the tablet opens inside FiveM.

You know you are ready when… #

• You know which of the three places will run Agora, and it has the memory and disk needed.
• You have a license key, or you know where to ask for the free trial.
• The curl command of section 3 answers with a line that starts with HTTP.
• You have a Discord account.

Next step: Your first day with Agora.

If it does not work #

• docker compose version answers "command not found" or a version 1: install Docker with the method of https://get.docker.com, which includes Compose v2.
• The curl command answers nothing or times out: your machine's network blocks outbound traffic. See License or update server unreachable.

Go further #

• No redirects. Agora reaches lic1.agorapanel.com and lic2.agorapanel.com directly and follows no redirect to these addresses: an outbound proxy that redirects makes the call fail.
• Disk space. Agora keeps two versions of the application on disk (the current one and the previous one), plus your backups.
• Ports. With Docker, Agora listens on port 3000 by default and also publishes port 40121 for the txAdmin tab. Open the first one in your machine's firewall so your visitors can get in; the second only if you want to use txAdmin from another computer.