Configuration

This guide covers setting up your MonoAdmin project and configuring your team.

---

Initial Setup (During Installation)

When you first access MonoAdmin, you’ll go through a 2-step project creation followed by server linking.

Step 1 of 2: Create a New Project

Enter the name of your FiveM server:

• Server Name — This will be used to identify your project
• Minimum 3 characters
• You can change this later

Click Next to continue.

Step 2 of 2: Select Framework

Choose the FiveM framework your server uses:

Framework	Description
ESX Legacy	The most popular FiveM framework
Qbox	Modern QBCore-based framework
Standalone	No framework, pure FiveM
Others	Coming Soon

Caution

Select the correct framework. This affects how MonoAdmin integrates with player data like money, jobs, and inventory.

Click Next to continue.

Step 3: Link Your Server

After selecting your framework, you’ll see the “Link Your Server” screen:

1. Your API Key is displayed at the top
2. The Server Console Command shows the full command to copy
3. Click Copy to copy the command
4. Paste and run it in your FiveM server console

monoadmin link ma_yourApiKeyHere...

The dashboard shows “Waiting for server connection…” while it waits.

Once your server connects, setup is complete and you’ll enter the dashboard.

---

Onboarding Wizard

After linking, the onboarding wizard helps you with initial configuration:

Welcome

A brief introduction to what you’ll configure next.

Roles Setup

Create your staff hierarchy:

1. Default Roles — MonoAdmin suggests roles (Admin, Moderator, Helper)
2. Custom Roles — Create roles that match your staff structure
3. Permissions — Assign specific permissions to each role

Tip

Start with the default roles and customize later as you learn what permissions your team needs.

Invite Members

Add your team members:

1. Enter team member email addresses
2. Select which role to assign them
3. Click Send Invites

Invitees receive an email with a link to join your project.

Tour

A quick walkthrough of MonoAdmin’s main features. You can skip this if you prefer to explore on your own.

---

Role & Permission Setup

Customize roles and permissions at any time in Settings.

Managing Roles

1. Go to Settings → Roles
2. View, edit, or create roles
3. Each role has:
   • Name — Display name (e.g., “Senior Moderator”)
   • Color — Role color for identification
   • Permissions — What this role can do

Permission Categories

Category	Description
Players	View player info, edit data, manage punishments
Economy	View/modify money, inventory, bank accounts
Moderation	Warn, kick, ban, manage reports
Administration	Manage roles, invite members, project settings
Monitoring	Access live grid, map tracking, analytics

Best Practices

• Least Privilege — Give roles only the permissions they need
• Separate Concerns — Economy staff vs moderation staff
• Audit Trail — All actions are logged, even for admins

---

Inviting Team Members

Invite additional team members at any time.

How to Invite

1. Go to Settings → Team
2. Click Invite Member
3. Enter their email address
4. Select their role
5. Click Send Invite

What Invitees Receive

Invited members get an email with:

• Link to join your project
• Instructions to create a MonoAdmin account (if they don’t have one)
• Their assigned role

Managing Team Members

From the Team page, you can:

• Change member roles
• Remove members from the project
• Resend invitations

---

Next Steps

Your MonoAdmin project is now configured! Here’s what to do next:

1. Quick Start — Learn the essential features in 5 minutes
2. Connect In-Game — Use /madmin to open the in-game admin panel
3. Explore the Dashboard — Browse players, view reports, check analytics

---

Need help? Join our Discord community for support.