Agora

Automatic installation on your panel

From your space, connect your Pterodactyl or Pelican panel with an API key: the site reinstalls the server you pick, wiping it. Meant for a server that already has Agora's egg.

Updated on Oct 5, 2026, 1:36 p.m.

On this page
  1. Before you start
  2. Steps
  3. You know it worked when…
  4. If it does not work
  5. Going further

In short. The Install on my panel page of your space can reinstall a server of your panel for you: it tests your API key, shows you the servers that can host Agora, then restarts the installation of the one you pick. Everything it contained is wiped. This route does not change the server's egg and does not set your license key: it therefore assumes that the server was already created with Agora's egg.

<!-- À CONFIRMER : AUT-1. Code vérifié (panel-deploy.ts, panel-core.ts) : l'appel au panel renvoie l'œuf actuel du serveur (egg: current.egg), ne fusionne que AGORA_INSTALL=panel (variable que boot.mjs ne lit pas) aux variables existantes, puis réinstalle. Sur un serveur dont l'œuf n'est pas celui d'Agora, le script d'installation de cet autre œuf ne dépose pas boot.mjs : serveur mort probable. À confirmer par un test sur le banc Pelican ; si confirmé, défaut produit à remonter (le titre de la page du site dit « Installer Agora sur mon panel »). -->

Before you start #

  • For a first installation, take the egg instead. Importing the egg then creating the server is the normal route: Install on Pterodactyl or Install on Pelican. Automatic installation is mostly for cleanly reinstalling a server that already has Agora's egg and its key.

  • A server already created with Agora's egg, whose Cle de licence variable is filled in. If that server already holds a Hub, its built-in database disappears too: first make an Agora backup and download it off the server (see Backups and restore).

  • A public panel, over HTTPS. The site must be able to reach your panel over the Internet: an address that starts with https:// and opens from anywhere. A panel installed on your local network is not accepted here. For a local panel, use the egg.

  • A server with enough resources: at least 1.5 GB of memory and 5 GB of disk (2 GB and 10 GB are more comfortable), because the server runs Agora and its database. Servers that are too small are greyed out in the list.

  • An API key from the panel. An API key is a token you create in your panel so that a program can drive it. There are two kinds, the first being recommended:

    • the admin key: Administration → Application API → Create New, with read and write rights on "Servers";
    • the account key: Account → API Credentials → Create. It cannot change the server's egg, but that does not matter here, since the egg must already be the right one.

    <!-- À CONFIRMER : AUT-3, chemin exact de la clé d'API d'administration sous Pelican (il est valable pour Pterodactyl), vérification banc -->

    <!-- CAPTURE C-061 -->

    <!-- CAPTURE C-060 -->

    <!-- CAPTURE C-062 -->

  • Not sure whether your panel is Pterodactyl or Pelican? See Tell Pelican and Pterodactyl apart.

Steps #

  1. Open the installation page of your space. On agorapanel.com, go to Install on my panel (My account → Install on my panel). If not done yet, prepare your license key with Get my free trial key.

  2. 1. Connect the panel. Paste the panel address (for example panel.myhost.com, over HTTPS) and the API key, then click Test connection. Nothing is stored until the test succeeds.

    <!-- CAPTURE C-056 -->

  3. 2. Pick the server. The site shows the recognised key type and the list of the panel's servers. Servers that are too small, suspended or being transferred are greyed out, with the reason.

    <!-- CAPTURE C-057 -->

  4. 3. Confirm, this step wipes the server. Pick the server, read the red warning, type the requested word (ECRASER), then click Wipe this server and install Agora.

    <!-- CAPTURE C-058 -->

  5. Follow the progress in your panel's console. The site shows "Install started": the panel reinstalls the server, and Agora starts as soon as the installation is over. Your API key is then wiped on our side. If the console says the license key is missing, enter it in the server's startup variables (the AGORA_KEY variable): you find it on the same page (Show the key), then restart the server. The automatic installation never sets your license key.

    <!-- CAPTURE C-059 -->

  6. Do the setup. When the console shows ✓ Ready in …, open http://IP:PORT (the server's address in your panel): see Do the getting-started setup.

You know it worked when… #

  • The site shows Install started.
  • The server's console, in your panel, goes through the installation again then shows ✓ Ready in ….
  • Your browser shows the Mise en route (setup) screen.

If it does not work #

MessageCauseWhat to do
This address points to a private networkYour panel is not publicInstall with the egg instead
That panel address cannot be usedBadly written addressWrite it like the example shown by the site: panel.myhost.com (over HTTPS)
Panel unreachableThe address is wrong, or the panel is not reachable from the InternetCheck the address and that the panel can be reached from outside
Key rejected by the panelWrong, deleted or badly copied keyCreate the key again and paste it again
This key lacks the required rights on serversAdmin key without read and write on "Servers"Create it again with both rights ticked
No server visible with this keyNo server is accessible to this keyFirst create a server with Agora's egg, or use a key that sees it
Too many panel tests in a short timeMore than 10 tests in 10 minutesWait a few minutes
Install session expiredThe test is more than an hour oldRun the test again
That server does not have enough memory or diskLess than 1.5 GB or 5 GBRaise them in the panel, then run the test again
An install is already running on that serverA reinstall is in progressWait for it to finish
After the install, the console asks for the license keyIt is not in the server's variablesPut your key in the server's AGORA_KEY variable, then restart
After the reinstall, the console mentions a license seat that is already takenThe reinstall wiped the installation's identity: the license thinks it sees another machineSet the Reprendre le siege variable to 1 for one start, then back to 0; see Free a license seat
The console says nothing or the server stops right awayThe server did not have Agora's eggImport the egg and change the server's: see Install on Pterodactyl or Install on Pelican

<!-- À CONFIRMER : dernière ligne du tableau (AUT-1), effet réel d'une réinstallation sur un serveur dont l'œuf n'est pas celui d'Agora ; messages d'erreur du tableau à relire après le test banc (AUT-5) -->

Going further #

  • What the admin key does. With it, the site sets Agora's Node image (ghcr.io/parkervcp/yolks:nodejs_22) and the startup command (node /home/container/boot.mjs) on the server, without touching its other variables, then restarts the installation. With an account key, it changes nothing except launching the reinstall.
  • What the site keeps of your key. It is stored, encrypted, only after a successful test. It is wiped as soon as the installation is over, and at the latest one hour after the test if you do not go through with it.
  • A running server is stopped before the reinstall: the list flags it.
  • Why not for a first installation? Because this route sets neither the egg nor the license key. It reuses what is already on the server.

Was this article helpful?