EasyAdmin Documentation¶
EasyAdmin is an administration system for FiveM and RedM servers. It provides a graphical interface for managing players, bans, reports, server resources, and more.
Quick Start¶
If you are setting up EasyAdmin for the first time, follow these steps in order:
- Install EasyAdmin -- Download, extract, and start the resource
- Add yourself as an admin -- Grant your identifier admin access
- Set your keybind -- Choose a key to open the menu
- Configure webhooks -- Set up Discord notifications
- Set up the Discord bot -- Optional, for remote management
Each step links to a detailed guide.
I Am a...¶
Server Owner¶
You want full control over your server, including moderation tools, Discord integration, and server management.
Installation
Set up EasyAdmin on your server in minutes.
Permissions
Configure admin roles and access levels.
Configuration
Set up webhooks, ban screens, and core options.
Updating
Update EasyAdmin to the latest version.
Moderator¶
You need to manage players, handle reports, and monitor server activity.
Player Management
Kick, ban, mute, freeze, and spectate players.
Ban List
Search, edit, and manage bans.
Reports
Review and process player reports.
Action History
View moderation history for any player.
Developer¶
You want to extend EasyAdmin with custom plugins, integrations, or exports.
Plugin API
Build runtime plugins that extend the NUI with schema-driven UI.
NUI Architecture
React/TypeScript SPA, communication with Lua, design system.
Convar Reference
All configuration variables with defaults and types.
Translating
Add or update language files.
Common Tasks¶
Find what you need by task:
| Task | Guide |
|---|---|
| Ban a player | Ban List |
| Set up Discord notifications | Webhooks |
| Add a Discord bot | Bot Setup |
| Configure permissions | Permissions Overview |
| Edit a ban | Editing Bans |
| Unban a player | Unbanning |
| Handle player reports | Reports |
| Set up chat reminders | Reminders |
| Add reason shortcuts | Shortcuts |
| Enable the allowlist | Allowlist |
| Change the menu key | Keybind |
| Monitor server resources | Resource Monitor |
| View player statistics | Player Statistics |
| Check network stats | Network Monitor |
| Update EasyAdmin | Updating |
Documentation Structure¶
| Section | Contents |
|---|---|
| Getting Started | Installation, basic configuration, permissions setup |
| Discord Integration | Bot setup, commands, logging, chat bridge, server status |
| Configuration | Webhooks, commands, action history, backups, shortcuts, advanced options |
| Features | Ban list, reports, screenshots, reminders, statistics, monitoring tools |
| NUI | Design system, page descriptions, known issues |
| Plugins | Runtime plugin system — schema-driven UI extensions |
| Reference | Complete convar, permission, and command listings |
| Updates | How to update EasyAdmin and handle breaking changes |
| Troubleshooting | Common issues and solutions |
Need Help?¶
- GitHub Issues -- Report bugs or request features
- Troubleshooting -- Common problems and solutions
- Discord Community -- Get help from the community