How to Connect Your FiveM Server to FiveGateway (Step by Step)
Getting your FiveM server connected to FiveGateway takes about five minutes. No complicated setup, no dependencies to install - just a resource folder, an API key, and two lines in your server config. This guide walks you through every step from account creation to seeing live data in your dashboard.
Step 1: Create Your FiveGateway Account
Head to my.fivegateway.com and sign in with your Discord account. That's it — no separate registration form. Your Discord username becomes your FiveGateway identity, and your account is ready immediately.
Step 2: Add Your Server
Once you're in the dashboard, click "Add Server". Enter your server's join link — this is the cfx.re link players use to connect to your server. It looks something like:
cfx.re/join/abc123
Give your server a name you'll recognize, then hit Save. FiveGateway uses this link to identify and communicate with your server.
Step 3: Copy Your API Key
After adding your server, FiveGateway generates a unique API key. You'll see it displayed on the server settings page. Copy it and store it somewhere safe.
🔒 Keep this key private. Anyone with your API key can send data on behalf of your server. Never share it publicly or commit it to a repository.
Step 4: Download the FiveGateway Resource
From your dashboard, navigate to the "Resource" section under your server. Download the fivegateway resource package. This is a standard FiveM resource that handles communication between your server and the FiveGateway platform.
For more details on what the resource does and its configuration options, check the FiveGateway documentation.
Step 5: Install the Resource on Your Server
Extract the downloaded archive and drop the fivegateway folder into your server's resources/ directory. The structure should look like:
resources/
fivegateway/
fxmanifest.lua
...
No other files need to move. The resource is self-contained.
Step 6: Configure Your server.cfg
Open your server.cfg and add these two lines:
set FIVEGATEWAY_API_KEY "your-key-here"
ensure fivegateway
Replace "your-key-here" with the API key you copied in Step 3. The set line registers the key as a server convar, and ensure starts the resource when the server boots.
💡 Tip: Place the
setline before theensureline so the key is available when the resource initializes.
Step 7: Restart Your Server
Restart your FiveM server. Within seconds, your FiveGateway dashboard will update to show the server as Online. If you're already running the server, you can also use the server console:
refresh
ensure fivegateway
Step 8: What You'll See
Once the connection is live, your dashboard immediately starts working:
- Live player list - every connected player appears in real time with their identifiers, ping, and session duration
- Action logs - joins, disconnects, and moderation events start flowing into your log feed
- Server stats - player count history, peak hour data, and uptime tracking begin populating automatically
The longer your server runs with FiveGateway connected, the more useful your analytics become. Check out the full list of dashboard features to see everything available to you.
Troubleshooting
If your server shows as Offline in the dashboard after restarting:
- Verify the resource is running. Type
ensure fivegatewayin your server console and check for errors in the output. - Double-check your API key. Make sure the key in
server.cfgmatches exactly what's shown in your dashboard — no extra spaces or quotes. - Check your firewall. The resource needs outbound HTTPS access. Make sure your host isn't blocking outgoing connections on port 443.
If you're still stuck, drop a message in the Discord and the team will help you sort it out.
Stay Updated
Follow development updates, feature announcements, and behind-the-scenes progress: