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
  • Whitelisting on QBCore / VMenu
  • Installation / Configuration
  • 1. Configure Clock In Module
  • Configuration
  • 2. Setup Whitelist Permissions
  • 3. Add your API ID
  • Reliability Notice

Was this helpful?

Edit on GitHub
  1. Integration Capabilities
  2. In-Game Integration Resources
  3. FiveM Installation
  4. FiveM Submodules

Whitelist

A whitelist system that utilizes Sonoran CMS's game whitelist system.

PreviousAce Permission SyncNextJob Sync

Last updated 12 months ago

Was this helpful?

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

This whitelist module utilizes Sonoran CMS's to enforce player connections.

Whitelisting on QBCore / VMenu

Installation / Configuration

With core version v1.4.0 the Whitelist resource was converted to a core module and no longer requires manual installation just configuration.

1. Configure Clock In Module

Locate the whitelist module within your [sonorancms]/sonorancms/server/modules folder and rename whitelist_config.dist.json so that it is just whitelist_config.json.

Next, open the whitelist_config.json file and set enabled to true.

Configuration

Config Option
Description

enabled

If set to true it will enable a whitelist for your server and only individuals granted Allow Whitelist as shown below.

2. Setup Whitelist Permissions

Navigate to the Rank Manager within the Administrative Panel.

Administrative Panel > Ranks

For users in your Sonoran CMS community to be accepted through the whitelist, they'll need to be granted permission for the whitelist through rank permissions.

Granting each rank the permission of Allow Whitelist allows those members through the whitelist.

Granting each rank with the permission of Block Whitelist blocks users from passing through the whitelist.

Block Whitelist will ALWAYS overrule Allow Whitelist If a user is granted both Block Whitelist and Allow Whitelist through various ranks they will be blocked from the whitelist. Block will always overrule allow.

3. Add your API ID

Reliability Notice

In the event that the CMS API is temporarily unavailable, this resource utilizes a local backup cache. The resource will automatically fall back to the latest saved version of the whitelist, allowing members to join as normal.

If using QBCore or VMenu on your server, it is recommended that you control whitelisting through their respective game panels, rather than through this plugin. For more information, see the links below:

Ensure all players have added their to the CMS!

QBCore Game Panel - Whitelisting
VMenu Game Panel - Whitelisting
API ID
server hosting
Sonoran CMS - Whitelist
Sonoran CMS - Departments & Ranks
Sonoran CMS - Rank Manger Server Permissions