Skip to main content

Installation

You only need 5 minutes. No coding required.

Before you start​

Make sure you have:

  • ✅ Your server registered and verified on fiverank.gg. If you haven't done this yet, go to Panel → Servers → Add server.
  • ✅ Access to your FiveM server's resources/ folder and server.cfg.

Step 1 · Generate your token​

  1. Log in to fiverank.gg.
  2. Go to Panel → Servers → [Your server] → FR Guard.
  3. Click Generate new API Key.
  4. Copy it (starts with frk_live_…).
Save it somewhere

The key only shows once. If you lose it, no problem — just revoke it and generate a new one.

Step 2 · Download the resource​

  1. Go to fiverank.gg/fr-guards.
  2. Click Download FR Guards (.zip).
  3. Unzip the file inside your server's resources/ folder.

It should look like this:

resources/
└── fiverank_guard/
    ├── fxmanifest.lua
    ├── config.lua
    └── ...

Step 3 · Edit your server.cfg​

Open your server.cfg and paste this at the end of the file:

# ─── FiveRank Guard ──────────────────────────────────────
set fiverank_token "frk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
set fiverank_language "en"
ensure fiverank_guard

Replace frk_live_xxx… with your token from step 1.

Step 4 · Restart your server​

Do a full server restart (not just the resource).

When it starts up, you'll see something like this in the console:

[FiveRank Guard] online · framework=esx · base=https://fiverank.gg
[FiveRank Guard] language=en · cache=5min · fail_open=true

✅ Done! Your server is now protected by FR Guard.

Step 5 · Verify it's working​

Connect to your server with your own FiveM. You'll briefly see a card saying "Checking your reputation…" followed by "Welcome!". That means everything is working.

If you see an error instead → go to Troubleshooting.

Let your players know

Ask them to register for free at fiverank.gg. The more players on FiveRank, the stronger the network gets for all protected servers.