Do the getting-started setup: key, Discord application, administrator

In short. Open your Hub (your Agora site) in a browser: the Getting started screen shows up on its own. In three steps, License key, Discord application and Administrator, your Discord account becomes your installation's administrator.

Before you start #

• Agora has started: the server console (or its logs, the messages it writes) shows Ready in …. If it does not, go back to step 4 of Your first day with Agora.
• You have your license key (it starts with AGORA-). You find it in your space on agorapanel.com, under My licences, with the Show key button: see Activate or change your license key. It is the same key as the one already set on your server: the screen checks that you know it.
• You have a Discord account and can open the Discord developer portal. It is the site where you declare a Discord "application", that is, Agora's identity at Discord.
• You know your Hub's address: http://IP:PORT. With Docker, it is your machine's IP address followed by :3000. On a panel, it is the address and port of the server's allocation (the Network tab). The technical words are explained in the glossary.

Steps #

Step 1: enter your license key #

1. Open the Hub at its address (http://IP:PORT is fine).
2. Paste your key in the License key field. Upper case and extra spaces do not matter.
3. Click Continue.

<!-- CAPTURE C-009 -->

An accepted key unlocks the next steps for 15 minutes. After that, the screen says "The setup session expired": enter the key again.

<!-- CAPTURE C-013 -->

Step 2: declare the Discord application #

At the top of the step, the screen shows the redirect URL, the address Discord will send your members back to after they sign in, with a Copy button. It is computed from the address you came in through: never type it by hand.

<!-- CAPTURE C-010 -->

1. In the Discord portal (sign in to Discord if asked), click New Application and give it a name.

2. Open the OAuth2 tab and copy the Application ID, a long string of digits.

   <!-- CAPTURE C-014 -->

3. Click Reset Secret and copy the secret shown: it is displayed only once.

4. In the Redirects section, add the URL given by Agora's screen, then click Save Changes.

   <!-- CAPTURE C-015 -->

5. Come back to Agora and fill in the three fields: Site name, Discord application ID (the Application ID) and Discord application secret.

6. Click Save and sign in with Discord.

The portal's button names are given in English. If your Discord is in French, the portal shows them in French: Create and set up your Discord bot shows each portal screen with its equivalents.

Discord accepts an http:// address on an IP address: you need neither a certificate nor a domain name to get started.

Step 3: become administrator #

1. Authorize the application on Discord: the screen asks for access to your identity and your email, nothing else.

   <!-- CAPTURE C-016 -->

2. Back in Agora, the screen shows "Signed in as …". Click Finish setup.

3. Click Open the admin area.

<!-- CAPTURE C-011 -->

No need to sign in again.

You know it worked when… #

• The top bar shows Moderation, Server and Administration.

  <!-- CAPTURE C-019 -->

• Administration → Agora shows your license state, "Trial" or "Active", with no "Last error".

  <!-- CAPTURE C-018 -->

• Your Hub's /api/health address answers "ok": true. Type it after the address of step 1: http://IP:PORT/api/health, or https://your-domain/api/health if you have a domain.

  <!-- CAPTURE C-017 -->

If it does not work #

Go further #

• In the browser, not in the tablet. The setup (and taking over as the first administrator) is only done from a browser, signed in with Discord: a session opened from the in-game tablet is refused, even for the first account.

• The door closes. As soon as an administrator exists, /mise-en-route only shows "This installation is already set up". Neither a key nor a token reopens it. To give rights to someone else, use Administration → Members. If you lost access, take it back from your hosting panel.

  <!-- CAPTURE C-012 -->

• Installation without a license key. If the AGORA_SETUP_TOKEN variable is set, step 1 asks for the setup token instead, which is the value of that variable.

• Limits. Eight attempts per IP address per quarter hour. A refusal never says why, on purpose.

• What the installation created for you. On a fresh database, Agora sets up a starting structure: the roles (Administrator, Moderator, Whitelist, Police, Justice, EMS…), two forum categories, a "whitelist request" form and a sample donation campaign awaiting review. Everything can be changed afterwards.

• What's next. Connect Discord (bot and roles, optional), Connect the game server database to open the MDT, then Install the agora FiveM resource for the tablet.