Skip to main content

​
Installation Steps

1

Download the resource

Choose one of the following methods:Option A — Git clone:
Option B — Download ZIP:
  1. Go to github.com/Rmz-App/rmz-fivem
  2. Click the green Code button and select Download ZIP
  3. Extract the folder into your server’s resources/ directory
  4. Rename the folder to rmz-fivem if needed
2

Get your secret key

  1. Go to your RMZ dashboard
  2. Navigate to Benefits > FiveM Servers
  3. Click Add Server
  4. Copy the generated secret key
3

Configure config.lua

Open config.lua in the resource folder and set your secret key:
See Configuration for all available settings.
4

Add to server.cfg

Add the following line to your server.cfg:
5

Restart your server

Restart the server (or run restart rmz-fivem in the console). You should see the following output in your server console:
If you see this output, the resource is running and polling for commands.

​
Verify the Connection

After starting the resource, check the FiveM Servers page in your RMZ dashboard:
  • Connected (green) — the resource is polling successfully
  • Disconnected (grey) — no poll received in the last 2 minutes
Never share your secret key or commit your modified config.lua to a public repository. Add it to your .gitignore file.

​
Next Steps

Configuration

Adjust poll interval, debug mode, and notifications

Product Setup

Create products with FiveM commands