Getting started

This guide takes you from a new account to a connected server.

Early access. Self-serve sign-up is not open yet. Request early access from the CAdmin website and we set up your network and trial with you; items 3 and 4 of section 1 then happen for you.

1. Sign in and create a network

1. Open the CAdmin dashboard and sign in with Discord.
2. Accept the Terms of Service and the Privacy Policy when asked.
3. Create a network. A network is your community: its servers, staff, players and data.
4. Start a free trial from Plan and billing, or choose a plan. A trial needs no card: 7 days on Starter, 14 days on Operations and Network. There is one trial per network and per person.

2. Connect your first server

You need a current FiveM server artifact with OneSync enabled, and access to the server console. If you run txAdmin, enable OneSync in txAdmin → Settings → FXServer: txAdmin comments out set onesync in server.cfg.

1. Get the free CAdmin resource from its store page and extract it so the path is resources/[cadmin]/cadmin/fxmanifest.lua. The folder must be named cadmin.

2. In the dashboard, open FiveM instance → Setup Center and create the server.

3. Copy the generated block into server.cfg, after your framework (ESX, QBCore, Qbox) and inventory resources. It contains the connection settings and ensure cadmin. It never contains a secret.

4. Start the server. In the Setup Center, generate the one-time enrollment token, then run it in the server console (never in player chat):

   cadmin:enroll <one-time-token>

5. Run cadmin:diagnose in the console. A working installation ends with CAdmin diagnostic result: PASS. The Setup Center shows each check turning green as it passes.

Repeat for each server your plan allows (Starter 1, Operations 3, Network 10).

Keep data/identity.json private: it is the server's identity. Do not copy it to another server or share it.

3. Invite your staff

1. Open Team and permissions and add your staff by their Discord account.
2. Give each person a role. Roles decide what they can see and do, such as viewing player identifiers, managing tickets or running remote actions.
3. Sensitive actions ask the person for a passkey confirmation.

Your plan sets how many members you can add (Starter 5, Operations 20, Network 75).

4. Discord tickets: bot permissions

CAdmin's Discord bot needs two permissions for the newest ticket features:

• Change Nickname: shows your ticket persona's name (for example "Nova") on the bot in your server.
• Manage Webhooks: makes staff replies sent from the CAdmin dashboard appear in the ticket under the staff member's name.

Servers that added the bot before these were requested keep working without them: tickets are created as usual, staff replies arrive as messages from the bot with the staff member's name in front, and the persona status in the dashboard shows "not applied" with the reason.

To turn them on, re-invite the bot from the invite link in the dashboard (same bot; your server admin approves the new permissions). Then save the ticket persona once in the dashboard so the name is applied. Staff replies use the new style from the next reply. If a channel override in your ticket category denies Manage Webhooks, remove it.

5. Next steps

• Set the billing contact in Plan and billing, so plan and payment notices reach the right person.
• Review event retention per event type. Each type keeps 30 days by default, up to your plan's limit.
• If you use voice observation or screen share (Operations and Network), tell your players about it. See the Evidence Policy.

Something not working? See the FAQ or open a ticket from Support.