VaultBBDocs
MyBBVaultBB Core

Admin UI Guide

A tour of the VaultBB admin panel — Dashboard, Plugins, Logs, and Updates.

Admin UI Guide

Once VaultBB Core is installed and activated, a VaultBB tab appears in the MyBB Admin CP top navigation. It contains four built-in pages, plus additional entries injected by any active VaultBB plugins.


Dashboard

URL: index.php?module=vaultbb-dashboard

The Dashboard is your at-a-glance view of the entire VaultBB ecosystem on your forum.

System Overview

A metric strip at the top shows four live counters:

MetricDescription
CoreThe currently running VaultBB Core version
PHPServer PHP version — shown in green if ≥ 8.0, red if older
MyBBYour forum's MyBB version
PluginsTotal number of registered VaultBB plugins

Health Checks

Two status rows confirm that the required database tables exist:

  • Logs table (vaultbb_logs) — Active / Inactive
  • Plugins table (vaultbb_plugins) — Active / Inactive

If either shows Inactive, the table is missing. Re-running Install & Activate on VaultBB Core will recreate it.

Registered Plugins

Lists up to 10 registered VaultBB plugins with their version, last-seen timestamp, and active/inactive badge. Active state is determined by cross-referencing MyBB's own plugin cache — not just the database column — so it accurately reflects which plugins are truly running.

If more than 10 plugins are registered, a link to the full Plugins page is shown.

Dashboard Widgets

Active VaultBB plugins can inject custom widgets below the registered plugin list. Widgets are discovered automatically: Core looks for a dashboard_widget.php file inside each active plugin's folder. That file returns the fully-qualified class name of the widget, which must expose a static render(): void method.

Any widget that throws an exception is silently skipped (and logged if Debug Mode is on), so a misbehaving plugin can never break the Dashboard.

Quick Actions

A row of shortcut buttons for common admin tasks:

  • View Plugins
  • View Logs
  • Core Settings
  • Plugin-specific shortcuts (e.g. Advanced Dice settings/profiles, when installed)

Plugins

URL: index.php?module=vaultbb-plugins

A full list of every plugin registered in the vaultbb_plugins table, including codename, version, minimum Core version required, install date, last update, and last-seen time.

Active state is always sourced from MyBB's plugin cache, not the database active column, ensuring the displayed status matches real plugin runtime state.


Logs

URL: index.php?module=vaultbb-logs

The Logs page displays the 50 most recent entries from the vaultbb_logs table, newest first.

Reading a Log Entry

Each entry shows:

  • Severity dot — colour-coded: blue (info), amber (warning), red (error)
  • Human-readable message — assembled from the action key and any known language strings (e.g. "ADVDICE: Plugin activated — v1.0.1")
  • Date & time — formatted according to your Time Format setting, adjusted for the forum timezone
  • IP address and User ID of the actor
  • Raw data toggle — click "Show raw" to expand a pretty-printed JSON block with the full log payload

Severity Levels

LevelColourWhen used
infoBlueRoutine events (activation, deactivation, data changes)
warningAmberNon-critical anomalies
errorRedFailures, exceptions, or dependency issues

Log Retention

Logs are automatically pruned by the daily cleanup task based on the Log Retention (days) setting. The Logs page always shows only live data from the table.

The Logs page does not yet support pagination or filtering via the UI. Entries beyond the 50-entry limit can be queried directly from the vaultbb_logs table, or via Logger::search() in custom code.


Updates

URL: index.php?module=vaultbb-updates

The Updates page checks all registered VaultBB plugins against the official manifest at https://vaultbb.com/vaultbb-updates.json.

How It Works

  1. Click Check for Updates to trigger a remote fetch.
  2. Core makes a single cURL request (8-second timeout) to the manifest URL.
  3. Each plugin's installed version is compared against the manifest's version field using semantic versioning.
  4. Results are cached in the vaultbb_update_cache setting and displayed instantly on subsequent page loads.

Update Status Labels

StatusMeaning
Up to dateInstalled version ≥ latest manifest version
Update availableInstalled version < latest manifest version
UnknownPlugin not found in the remote manifest

Cooldown

To prevent manifest spam, a 10-minute cooldown is enforced between remote fetches. The "Check for Updates" button is visually disabled until the cooldown expires. The time remaining is shown alongside the last-checked timestamp.

The Update Checker requires the PHP curl extension. If curl is unavailable, the check will fail gracefully and display a clear error message without crashing the page.


The VaultBB admin tab is only shown when VaultBB Core is active in MyBB's plugin cache. If you deactivate Core, the tab disappears automatically — no manual editing required.

Plugin-injected Menu Entries

Active VaultBB plugins can add their own entries to the VaultBB submenu by providing an admin_menu.php manifest file inside their plugin folder. Core's module_meta.php scans all active plugins at runtime and merges their menu entries, actions, and permissions automatically. Plugin entries always appear after Core's reserved slots (Dashboard, Plugins, Logs, Updates).

Admin Permissions

Standard MyBB admin group permissions apply to the VaultBB module. The built-in permission keys are:

KeyControls access to
dashboardDashboard page
pluginsPlugins page
logsLogs page
updatesUpdates page

Plugin-specific permission keys are merged in by each plugin's own admin_menu.php manifest.

On this page