LogoLogo
SupportServer Hosting
  • Sonoran CMS
  • 📱Download the App
  • Other Products
    • 🖥️ FiveM Hosting
    • ⌨️ Sonoran CAD
    • 📡Sonoran Radio
  • Why choose Sonoran CMS?
    • 🏆Why Choose Sonoran CMS?
  • Tutorials
    • Getting Started
      • Account Registration
      • Community Registration
      • Inviting Users
      • Troubleshooting
    • User Management
      • Creating Ranks
      • Setting User Ranks
      • Community Profile
      • Creating Rosters
    • Community Website
      • Website Builder
      • Toolbar Customization
      • Forums
      • Image Gallery
      • Navigation Permissions
    • Customization
      • Community Branding and Settings
      • Custom Domain / Vanity URL
      • Profile Fields
    • Calendar Events
    • Drive & Documents
    • Forms and Applications
      • Creating Forms
      • Form Submissions
      • Clock In/Out System
    • Administrative
      • Archive Community Member
      • Delete & Transfer Community
      • Delete User Account
      • View Your Limits
      • Growth and Discovery
        • Growth Panel
        • Discovery
      • Security Center
        • Account Flags
        • Logging Center
      • Disciplinary Panel
      • URL Shortener
  • Integration Capabilities
    • Sonoran CAD Sync
    • Sonoran Radio Sync
    • Discord Bot Integration
    • TeamSpeak 3 Role Sync
      • Getting Started
      • Adding Ranks
      • Adding your TeamSpeak UID
    • Discord Rich Presence
    • Discord Webhooks
    • FiveM Game Panel
      • Installation
      • QBCore & Qbox Panel
        • Dashboard
        • Players
        • Vehicles
        • Whitelist
        • Logs
        • Resources
        • Aces & Principals
        • Characters
        • Items
        • Jobs
        • Gangs
        • Job Sync
        • Environment
      • vMenu Panel
        • Dashboard
        • Players
        • Vehicles
        • Environment
        • Whitelist
        • Logs
        • Resources
        • Aces & Principals
    • Sonoran Shield
    • In-Game Integration Resources
      • FiveM Installation
        • FiveM Installation - Next Steps
        • FiveM Submodules
          • Clock In
          • Ace Permission Sync
          • Whitelist
          • Job Sync
      • Minecraft Integrations
        • Minecraft Resource Installation
        • Available Resources
          • Whitelist
      • Roblox Integrations
        • Roblox Resource Installation
        • Available Resources
          • Whitelist
      • IP Whitelisting
  • Developer API Documentation
    • 📖API Integration
      • Getting Started
        • Retrieving Your Credentials
        • API ID System
      • Push Events
        • Account Updated
        • Account Kicked
        • Account Banned
      • API Endpoints
        • General
          • Get Sub Version
          • Check Com API ID
          • Get Com Account
          • Get Current Clock In
          • Get Accounts
          • Get Departments
          • Get Profile Fields
          • Get Account Ranks
          • Set Account Ranks
          • Clock In Out
          • Kick Account
          • Ban Account
          • Edit Account Profile Fields
        • Servers
          • Get Game Servers
          • Set Game Servers
          • Verify Whitelist
          • Full Whitelist
        • Events
          • RSVP
        • Rosters
          • Get Roster Contents
        • Disciplinary
          • Get Member Points
          • Get Member Records
          • Add Member Record
          • Update Member Record Points
          • Update Member Record Reason
    • 🌎Translation Support
  • Roadmap
    • 📋Changelog
  • Other
    • Sonoran CMS
    • AI QA
    • Contact Us
    • Policy
      • Terms of Service
      • Privacy Policy
      • Refund and Purchase Policy
      • Promotions
        • 03/10/25-03/17/25 Suggestions
  • Pricing
    • Pricing FAQ
      • Branding Removal
      • Military and First Responder Discount
      • Expert Installation
      • Free Plugin Installation and Discount - Sonoran Servers
      • Accessing the Payment Center
      • Create and Manage a Subscription
      • Request Discord Role
    • View and Compare Plans
Powered by GitBook
On this page
  • A. One-Click Installation (RocketNode)
  • B. Pre-Configured Resource Installation
  • 1. Download the Resource
  • 2. Install the Resource
  • 3. Configure and Rename
  • 4. Server Config
  • 5. Configure Submodule Features
  • Updates
  • Troubleshooting
  • Server Crashes
  • Ensure your resource is up-to-date and download the latest release.
  • Ensure your API ID is set correctly.
  • Yarn Error

Was this helpful?

Edit on GitHub
  1. Integration Capabilities
  2. In-Game Integration Resources

FiveM Installation

The CMS Core maintains common utility functions and push event handling.

PreviousIn-Game Integration ResourcesNextFiveM Installation - Next Steps

Last updated 22 days ago

Was this helpful?

Looking for VPS, web, or dedicated hosting? Check out our official !

A. One-Click Installation (RocketNode)

We've partnered with Rocket Node to bring you one-click Sonoran CMS installation for FiveM — making it easier than ever to host your community and connect with Sonoran CMS.

  • Use code SONORAN to save big!

After installation, learn about configuring the submodule features.


B. Pre-Configured Resource Installation

1. Download the Resource

2. Install the Resource

Extract the [sonorancms] folder into your server's resources folder.

3. Configure and Rename

Open sonorancms\config.CHANGEME.lua, update the values, then save it as config.lua.

Default configuration is below:

Configuration Details

Configuration Options
Config Option
Description

APIKey

API Key found in the API Integration section of the Administrative Panel

CommID

Community ID found in the API Integration section of the Administrative Panel

allowAutoUpdate

When enabled, the resource will update itself. When disabled, it will simply show an update notification every 2 hours.

debug_mode

When set to true, useful debugging information it outputted to the console. Keep disabled in production due to console spam.

apiUrl

Default: https://api.sonorancms.com/

apiIdType

Type of api ID the core script should be searching for: discord, steam, license, etc.

serverId

Default: 1 - ID of the Sonoran CMS server that this core resource should be tied to.

framework

none, qb-core, or esx

MaxInventorySlots

If using framework: qb-core you can specify the max inventory slots your inventory resource supports, this is for inventory management via the Game Panel's within Sonoran CMS.

restartWithPlayers

When set to true, it will auto-update the resource and restart it even if players are present on the server.

4. Server Config

Add the following to your server.cfg

It is very important that the sonorancms_updatehelper resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.

DO NOT start the whole [sonorancms] folder as that will also start the sonorancms_updatehelper which might cause crashing if it is started manually.

Example of what not to do: ensure [sonorancms]

exec @sonorancms/sonorancms.cfg

5. Configure Submodule Features

The CMS Core resource comes with a variety of submodules included by default. These handle a variety of features such as whitelisting, permission synchronization, and more.


Updates

Sonoran CMS's core will automatically update with the latest features, fixes, and changes!

Troubleshooting

Server Crashes

Check to make sure sonorancms_updatehelper is not being started in your server.cfg.

It is very important that the sonorancms_updatehelper resource is not started manually. Doing so may cause a server crash if updates are available due to a race condition.

Ensure your resource is up-to-date and download the latest release.

CMS updates are released often. Make sure your server is running on the latest release.

Ensure your API ID is set correctly.

Yarn Error

Some users will see this in their server console:

[ script:yarn] Error: [yarn] error @discordjs/collection@1.5.3: The engine "node" is incompatible with this module. Expected version ">=16.11.0". Got "16.9.1"
[ script:yarn] Error: [yarn] error Found incompatible module.
[ script:yarn] [yarn] info Visit https://yarnpkg.com/en/docs/cli/install for documentation about this command.
[ citizen-server-impl] Building resource sonorancms failed.
[ citizen-server-impl] Error data: yarn failed!

In the case of this error, please locate the file named .yarn.installed, open it in any editor, then save it (without modifying anything).

This updates the "date modified" value for that file, which should then allow it to build correctly.

Click to download the core resource.

If your community is using recommended Discord integration, ensure your is linked.

For other methods (Steam, FiveM License, etc.) ensure you have set your using the API ID that your community is looking for.

If you are having trouble with this, feel free to, our support team will be happy to help you!

FiveM Installation - Next Steps
here
FiveM Installation - Next Steps
Discord account
API ID in the CMS
reach out to us
server hosting
Purchase your FiveM Game Server!
Sonoran CMS - Resource Installation Folder