Docs/ORB Web Admin/Installation

Installation

Requirements

  • FiveM server build 6116 or higher
  • oxmysql (required — used to read framework data)
  • A framework: QBox, QBCore, or ESX (optional; standalone works with reduced features)
  • An open TCP port for the web panel (default 8080)
The Node.js dependencies the panel needs are **bundled** with the resource — you do not need to run `npm install`.

Download & Extract

  1. 01Download orb-webadmin and orb-stream from your Tebex dashboard
  2. 02Extract both folders into your server's resources/ directory
  3. 03Keep the folder names orb-webadmin and orb-stream

Configure server.cfg

cfg
ensure oxmysql
ensure orb-webadmin
ensure orb-stream
Load `oxmysql` and your framework **before** `orb-webadmin`. Keep `orb-stream` loaded so live streaming is available.

Set Your Login & Port

Open config.js and set the web port and your owner account before first start:

js
Config.WebPort = 8080;

Config.Users = [
    { username: 'admin', password: 'CHANGE_ME_NOW', role: 'owner' },
];
Change the default password immediately. The `owner` account cannot be deleted or demoted from the UI.

Open the Panel

Navigate to:

http://YOUR_SERVER_IP:8080

Log in with the credentials from config.js. From there you can create more staff accounts and assign roles.

Editable Files

The resource ships with escrow encryption. The files listed in escrow_ignore are editable:

  • config.js — Port, accounts, roles, permissions, actions, streaming settings
  • bridge/*/ — Framework bridge (extend it for custom frameworks)
  • locales/*/ — All translatable text
  • public/config_ui.js — Web panel theming
  • nui/config_ui.js — In-game menu theming

Data Storage

ORB Web Admin does not create SQL tables. It reads your framework's existing tables (players, vehicles, etc.) and stores its own state as JSON files under data/:

FileContents
accounts.jsonStaff accounts and custom roles
ban.jsonActive bans (with all captured identifiers)
log.jsonAdmin action audit log
logDeath.jsonDeath log
logGunshot.jsonGunshot log
settings.jsonServer name, IP, welcome message