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 the Web Port

Open config.js and set the port the panel listens on (default 8080):

js
Config.WebPort = 8080;
There is **no password to set in `config.js`** — you create your owner account on first launch (next step). `Config.Users` is left empty by default.

Create Your Owner Account (First Launch)

Start the resource, then open the panel in your browser:

http://YOUR_SERVER_IP:8080

On the very first launch, the panel shows a one-time Create Owner Account screen. Choose your own username and password — that account becomes the owner. Your password is stored hashed (scrypt); it is never written to disk in plain text, and there is no default credential to leak.

Once the owner exists, the setup screen closes permanently and everyone signs in from the normal login page. From the Accounts & Roles page you can then 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 (passwords hashed with scrypt) 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