Installation

This guide walks you through installing and connecting the MonoAdmin resource to your FiveM server.

---

Step 1: Get the Resource

1.1 Purchase & Link to Cfx.re Account

1. Purchase MonoAdmin from crispydevs.tebex.io/package/monoadmin
2. During checkout, link the purchase to your Cfx.re account

1.2 Download from Cfx.re Asset Portal

1. Go to portal.cfx.re
2. Log in with your Cfx.re account
3. Navigate to Assets
4. Find MonoAdmin and download the resource

1.3 Install the Resource

Extract the contents to your server’s resources folder:

resources/
└── monoadmin/
    ├── fxmanifest.lua
    ├── config.lua
    ├── server/
    ├── client/
    └── ...

---

Step 2: Configure server.cfg

Add the following to your server.cfg:

For ESX/Qbox (with database)

# oxmysql must start before monoadmin
ensure oxmysql

ensure monoadmin

For Standalone (no database)

ensure monoadmin

---

Step 3: Resource Configuration

Open config.lua in the monoadmin resource folder. Here are the key settings:

Config = {}

Config.Framework = nil  -- Do not touch. Configured by the cloud.

-- Commands (set to false to disable)
Config.ReportCommand = 'report'              -- Players use /report to submit tickets
Config.OpenGameAdminPanelCommand = 'madmin'  -- Staff use /madmin to open panel
Config.OpenGameAdminKeyBind = ''             -- Leave blank for user to set via ESC menu

-- Community Service settings
Config.CommunityService = {
    spawnCoords = { vec4(159.309891, -997.345032, 29.347290, 144.566910) },
    centerPoint = {
        coords = vec4(159.309891, -997.345032, 29.347290, 144.566910),
        radius = 100.0
    },
    trashPickup = { ... },      -- Trash pickup locations
    trashModels = { ... },      -- Prop models for trash
    releaseCoords = { ... },    -- Release location after service
    workflows = {
        onCommunityService = { function() end },        -- Called when service starts
        onCommunityServiceRelease = { function() end }  -- Called when service ends
    }
}

---

Step 4: Create Project & Link Server

Connect your server to the MonoAdmin cloud.

4.1 Create a Project

1. Log in to monoadmin.net/dashboard
2. Click “Create New Project”
3. Step 1 of 2: Enter your Server Name and click Next
4. Step 2 of 2: Select your Framework (ESX Legacy, Qbox, or Standalone) and click Next

4.2 Link Your Server

After creating the project, you’ll see the “Link Your Server” dialog:

1. Your API Key is displayed at the top
2. The Server Console Command section shows the full command ready to copy
3. Click Copy to copy the complete command

4.3 Run the Link Command

Start your FiveM server, then paste and run the command in your server console (txAdmin or terminal):

monoadmin link ma_yourApiKeyHere...

The dashboard will show “Waiting for server connection…” while it waits. Once connected, you’ll see:

[MonoAdmin] Attempting to authenticate...
[MonoAdmin] ✓ Authentication successful!

Tip

The API key is stored securely and persists across server restarts. You only need to link once!

Available Commands

Command	Description
monoadmin link [api_key]	Link server with your API key
monoadmin unlink	Unlink server (for re-linking or troubleshooting)
monoadmin status	Show current connection status

---

Step 5: Verify Installation

Once linked, verify everything is working:

Check Connection Status

Run in server console:

monoadmin status

You should see:

[MonoAdmin] Status:
  Token: Set
  Initialized: Yes

Verify in Dashboard

1. Go to monoadmin.net/dashboard
2. Select your project
3. Your server should show as Online with a green indicator

---

Troubleshooting

”Authentication Failed” Error

• Verify your API key is correct (copy it again from the dashboard)
• Run monoadmin unlink then monoadmin link YOUR_API_KEY to retry
• Check that your server can reach the internet

”Server is not linked” on Restart

• This shouldn’t happen — tokens persist across restarts
• If it does, run monoadmin link YOUR_API_KEY again
• Check for resource errors preventing KVP storage

”Framework Not Detected” Warning

• This is normal for Standalone servers
• For ESX/Qbox, ensure the framework resource is started before MonoAdmin

Resource Won’t Start

• Check for Lua errors in the server console
• Verify all files were extracted correctly

---

Next Steps

Now that MonoAdmin is installed and connected:

1. Configuration — Set up roles, permissions, and invite your team
2. Quick Start — Learn the essential features in 5 minutes

---

Need help? Join our Discord community for support.