FIVEB guide

Overview

FiveB is a website and admin panel for FiveM (GTA RP) servers, plus a FiveM resource that connects the game to the website.

You received two zip files: fiveb-1.0.0.zip (the website) and fiveb-fivem-x.y.z.zip (the FiveM resource, versioned separately).

Requirements

Install

1. Create a database
   In your hosting panel, create an empty MySQL database and a user. Write down the database name, user and password.
2. Upload the files
   Unzip fiveb-1.0.0.zip and upload the whole content of the fiveb-1.0.0 folder to your hosting (FTP or file manager). Hidden files such as .htaccess must be uploaded too.
3. Point your domain
   Best: set the domain's document root to the public/ folder.
   Otherwise (shared hosting without that option): keep the root on the main folder; the provided .htaccess redirects to public/.
4. Check permissions
   storage/, bootstrap/cache/ and public/uploads/ must be writable (755 or 775). The installer tells you if one is not.
5. Open the installer
   Go to https://your-domain.com/install.

The installer

The installer is a guided browser wizard in six screens: a requirements check, then five forms. It locks itself when finished.

You then land in the admin panel at /admin. Example content (rules, FAQ, factions, lore) is installed in the language chosen during installation so the site is not empty: edit or delete it.

Cron job REQUIRED

Without it, emails and Discord notifications are not sent, vote rewards and monthly awards are not given, the license is not re-checked, and no backup is made.

In your hosting panel (Cron jobs), add a task that runs every minute:

* * * * * php /path/to/fiveb/artisan schedule:run >> /dev/null 2>&1

• Replace /path/to/fiveb with the folder that contains the file artisan.
• On some hosts php is called php8.2 or /usr/local/bin/php. Your host's documentation tells you which.
• Hosting panels with a "minute" dropdown: choose every minute (*) for all fields.

What it runs: daily license check, daily database backup (the last 7 are kept in storage/app/backups), IP privacy clean-up, server status samples, monthly vote awards, and the queue for emails and Discord messages.

First settings

The admin sidebar has one entry per subject (Players, Server, Whitelist, Staff, Factions, Community, Votes, Shop, Content, Rules, Lore, Settings, Users & roles), grouped under a few headings that you can open and close. Inside a subject, its pages are tabs in a frame under the page title. Moving around never reloads the whole page. Menu names below read subject → tab.

FiveM resource

The resource links your game server to the website: characters, playtime, live status, bans and whitelist at connection, and the commands of the admin panel.

1. Create the server in the admin
   Server → Servers → New server. Copy the API key: it is shown only once.
2. Install the resource
   Unzip fiveb-fivem-x.y.z.zip into your server's resources/ folder. You get a folder named fiveb.
3. Edit fiveb/config.lua
   Set at least:

   Config.ApiUrl = 'https://your-domain.com/api/fivem'
   Config.ApiKey = 'the-key-you-copied'
   Config.Access.WebsiteUrl = 'https://your-domain.com'

4. Start it in server.cfg
   After es_extended / qb-core:

   ensure fiveb

5. Restart and check the console
   You should see:

   [fiveb] framework: esx
   [fiveb] connected to https://your-domain.com/api/fivem (resource 1.6.1)

config.lua reference

Linking a player's account

On the website, a player opens Link FiveM and gets a code. In game they type /fivelink CODE. After that their characters, playtime and purchases appear in My space. /myid shows their identifiers.

ESX · QBCore · standalone

• ESX / QBCore: the resource detects them (Config.Framework = 'auto'). Start fiveb after es_extended or qb-core. ESX identifies characters by identifier, QBCore by citizenid. Force the framework only if detection fails.
• Standalone (vMenu or any server without ESX / QBCore): leave Config.Standalone = true. Each player appears with their FiveM name and playtime. Money, job and inventory stay empty (“—”). Money, item and job commands cannot work there: the admin warns you and the command shows as failed.
• The framework detected by the resource is shown in Server → Servers.

Player actions & command history

In Players → Players each row has buttons. They queue a command that the resource runs in game within about 10 seconds.

Every command and its result (pending, done, failed with the reason) is listed in Server → Commands. A command for an offline player stays pending and runs when they connect (for rewards and jobs).

Discord

FiveB talks to Discord through its REST API and webhooks only: nothing runs permanently on your hosting. Everything is in Settings → Discord (administrators only). The cron job must be running.

1 · Player login (OAuth2)

1. Open discord.com/developers/applications → New Application.
2. OAuth2 tab: copy the Client ID and Client Secret.
3. In Redirects, add exactly the URL shown in the FiveB admin: https://your-domain.com/auth/discord/callback.
4. Paste the Client ID and Secret in Player login.

2 · The bot

1. Same application → Bot tab → Reset Token and copy it. It is stored encrypted and never shown again.
2. No privileged intent is needed.
3. OAuth2 → URL Generator: scope bot, permissions Manage Roles, View Channels, Send Messages, Embed Links. Open the URL and invite the bot to your Discord server.

Once the bot token and the server ID are saved, the admin shows dropdowns of your roles and channels: no need to copy IDs by hand. To copy an ID, enable Developer mode in Discord (User settings → Advanced), then right-click the server, role or channel.

3 · Synced roles

FiveB never touches roles that are not listed in its settings. The player must have linked Discord (login with Discord) and be a member of your Discord server. Manual resync: Users & roles → Users → Resync Discord roles (one player) or Settings → Discord → Resync all roles.

4 · Notifications

Enable each event separately with its own channel: new and decided whitelist application, new and decided staff application, new support ticket, ban, store purchase, vote. With the bot, pick a channel per event. Without it, set a fallback webhook URL (Discord → channel settings → Integrations → Webhooks). Messages can never mention @everyone, @here, a role or a player. Use Send a test notification to check.

Tebex store

Cfx.re requires Tebex to sell anything linked to a FiveM server. FiveB integrates with it: products are created in Tebex and displayed on /store, payment is on Tebex's secure page, delivery in game is done by the official Tebex plugin, and FiveB receives signed webhooks to show each purchase in the player's history and in Shop → Tebex payments.

On the Tebex side

1. Create a webstore on creator.tebex.io (game: FiveM).
2. Create your packages and, for each, the command to run in game (Game server commands).
3. Integrations → API Keys: copy the Public token (and the Private key if needed).
4. Developers → Webhooks → Endpoints: add https://your-domain.com/webhooks/tebex, tick at least payment.completed, payment.refunded, payment.declined and payment.dispute.*, then copy the Webhook secret.

On the FiveB side

1. Shop → Tebex (administrators only).
2. Paste the Public token and the Webhook secret (and the Private key if needed).
3. Tick Store enabled and save.
4. Back in Tebex, click Validate next to the webhook: FiveB answers automatically.

On the game server

In server.cfg, add the secret of your game server from the Tebex panel:

sv_tebexSecret "your-tebex-server-secret"

Secrets are stored encrypted and never sent back to the browser. A purchase is linked to the player through a signed cart value, or through the fivem: identifier of their linked account (/fivelink). Refunds and chargebacks are recorded and logged. The store can be switched off in Settings → Modules.

Whitelist

Players apply on the website; staff review the application; the game server refuses anyone without an approved one.

1. Turn the module on
   Settings → Modules: tick Whitelist.
2. Open applications
   Whitelist → Whitelist settings: tick Whitelist enabled (untick to close applications). Optional Discord webhook for new applications and decisions.
3. Write your questions
   Whitelist → Whitelist questions: add, order and require the questions players answer.
4. Review applications
   Whitelist → Whitelist applications: accept or refuse, with comments. Needs the permission review.whitelist. The player is notified (email, in game if online, Discord if enabled) and receives the Discord role.
5. Enforce it in game
   Keep Config.Access.CheckWhitelist = true. A player must have linked their account with /fivelink to be recognised; otherwise they are told how to apply.

Votes

Players vote for your server on ranking sites and receive a reward. No reward is given without a check by the vote site's API, done by your web server (never by the player's browser), and a vote can only be rewarded once. Player page: /voter (enable the link in Settings → Appearance, Server pages).

top-serveurs.net

1. On top-serveurs.net, open your server's management and copy the vote token and the vote page URL.
2. Votes → Vote sites → New: provider top-serveurs.net, paste the URL ({username} is replaced by the player's name where the site allows it) and the API token (stored encrypted).
3. Choose the verification method, the delay between two votes (120 minutes for top-serveurs) and the reward.

Other vote sites

Choose Other site and enter the verification URL given by that site, with the variables {token}, {ip}, {username}, {steam} (HTTPS only), plus the JSON key that is true when the player voted (for example success or data.voted).

Rewards and monthly ranking

• Money and items are given as soon as the player is connected; offline players receive them at their next login. The player must have linked their FiveM account.
• /voter shows the monthly top 10 (optionally on the home page). Votes → Vote settings also sets a reward for the top 3, given automatically on the 1st of the month at 00:15 (cron job required), never twice.

Pages & modules

Pages and content

Which pages appear in the website menu is set in Settings → Appearance. The legal pages (privacy, cookies) are included; GDPR tools (cookie banner, data export and deletion, IP retention) are built in.

Modules

Optional features that you switch on or off in Settings → Modules:

A module that is off disappears from the public site and the admin menu; its data is kept.

Roles & permissions

Staff access is controlled by roles. Create and edit them in Users & roles → Roles, and assign them to a user in Users & roles → Users. The Administrator role has every permission.

A Moderator role is installed with access.admin, moderate and view.logs. Roles can also be shown on the public /equipe (team) page and linked to a Discord role.

Two-factor authentication (2FA)

2FA adds a code from an authenticator app (Google Authenticator, Authy, 1Password…) to the password.

1. Enable it on your account
   Log in on the website, open My space → Security, scan the QR code and enter the 6-digit code.
2. Save your recovery codes
   Keep them somewhere safe (password manager, paper). Each one works once if you lose your phone.
3. Require it for staff
   Settings → Appearance → Security: Require two-factor authentication for the administration. Staff must then enable it before opening the admin panel. Enable it yourself first.

To disable it, the account's password is required. If an administrator loses both their device and their recovery codes, another administrator can no longer reset it from the panel: contact support (see Support).

Themes

FiveB separates the code from the look of the public site. The look is a theme. The built-in one is Los Santos Nights (default): it cannot be deleted.

• Install: Settings → Themes → upload a theme .zip, then activate it. Themes live in the themes/ folder.
• Customise: each theme exposes options (colours, switches, images) under Customise the active theme. Name, logo, accent colour and home image are in Settings → Appearance.
• Signed themes: a theme signed by a trusted publisher installs without a warning. An unsigned or unknown one asks you to confirm.
• Safe fallback: a theme only needs the pages it changes; anything missing comes from the default theme. If a theme breaks the site, run php artisan fiveb:theme-reset to go back to the default theme.
• Create your own: a theme is a folder with theme.json, views/ (Blade) and assets/. The developer guide is docs/THEMES.md in the zip.

License

• One license = one domain. The first domain that validates your key is bound to it. localhost and .test / .local addresses are always allowed for testing.
• FiveB checks the license with brixa.be at install and once a day. Your key itself is never sent: only a signed hash.
• If brixa.be cannot be reached, the site keeps working for 72 hours (grace period). The admin panel always stays reachable so you can fix the license.
• Status, masked key and last check: Settings → License. Force recheck re-validates immediately; Change license key keeps your current license if the new key is refused.
• Moving to a new domain: contact support to reset the binding, then activate again.

The full terms are in LICENSE.md (English) and LICENCE.md (French).

Updates & backups

When a new version is published, the admin shows “update available” within 12 hours (read from brixa.be, no key sent).

1. Back up
   Your database (hosting panel or phpMyAdmin) and your files. FiveB also makes a daily database backup in storage/app/backups (the last 7).
2. Upload the new files over the old ones
   Do not delete or overwrite: .env, storage/, public/uploads/ and your own themes in themes/.
3. Open the admin
   FiveB applies the database updates by itself on the first request.
4. Update the FiveM resource
   When a new fiveb-fivem zip is provided, replace the fiveb folder but keep your config.lua (compare it with the new one for added options), then restart the resource. The admin flags an outdated resource in orange.

Release notes are in CHANGELOG.md.

FAQ & troubleshooting

Support

Ask for help through brixa.be. The more complete your request, the faster the answer (details in SUPPORT.md in the zip). Please send:

• Your license key and your FiveB version (bottom of the admin panel).
• A screenshot or the exact message you see.
• The last lines of storage/logs/laravel.log (website problems) or the [fiveb] lines of the server console (game problems).