Installation and updates
Docker, Pterodactyl, Pelican, Node.js server, variables, proxy, one-click updates, backups and moving.
- Install with Docker (install.sh)A single command installs Agora and its PostgreSQL database on a Linux machine with Docker: you have no database to prepare.
- Tell Pelican and Pterodactyl apartThree checks, with nothing to install, to find out which of the two panels you have and therefore which Agora egg to take: the name at the bottom of the panel, the Eggs or Nests menu, the start of your API keys.
- Install on PterodactylImport the Pterodactyl egg downloaded from your space, create a server with it, then start it: the Hub's database is built in, you have nothing to provide.
- Install on PelicanImport the Pelican egg (not the Pterodactyl one), create a server with it, then start it: the Hub's database is built in, you have nothing to provide.
- Install on a host's Node.js server (agora.mjs)Only have an ordinary host's customer panel? Order a Node.js server, drop a single file (agora.mjs) and your key: Agora installs its database and everything else.
- Automatic installation on your panelFrom 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.
- Environment variablesWhere and how to change Agora's startup settings depending on your installation route (Docker, panel, Node.js server), and the list of the ones that matter.
- Behind a proxy: HTTPS, Cloudflare and visitor IP addressesGet HTTPS for your Hub (Caddy, Cloudflare, your host's proxy, Nginx), then set AGORA_TRUSTED_PROXIES and let live streams through.
- One-click updates (and the beta channel)Administration → Agora backs up the database, downloads and verifies the new version, migrates, restarts, and rolls back on its own if it does not start.
- Backups and restoreBack up Agora's database from the admin area, download it off the server and restore it. A panel's file copy is not a backup.
- Move Agora to another machineBack up the database, copy the files and the session secret, reinstall on the new machine (Docker, panel or Node.js), restore, then take over the license seat.
- Uninstall AgoraBack up, stop and remove Agora (Docker, panel or Node.js), remove the FiveM resource and, if you want, the agora_ tables from the game database.