VaultBBDocs
MyBBVaultBB Core

Installation & Setup

How to install VaultBB Core on your MyBB 1.8.x forum.

Installation & Setup

VaultBB Core is the foundational framework required by all VaultBB premium plugins. It must be installed and activated before any other VaultBB plugin.

Requirements

RequirementMinimum Version
MyBB1.8.0
PHP8.0.0
MySQL / MariaDBAny version supported by MyBB 1.8
PHP extensioncurl (required for the Update Checker)

VaultBB Core requires PHP 8.0 or newer. Attempting to install on an older PHP version will produce an environment assertion error and abort gracefully.


Installing VaultBB Core

Upload the files

Extract the release .zip and upload the contents of the UPLOAD/ folder to your MyBB root directory, preserving the directory structure.

UPLOAD/
├── admin/
│   └── modules/
│       └── vaultbb/          ← VaultBB admin tab
└── inc/
    ├── languages/
    │   └── english/
    │       └── admin/
    │           └── vaultbb_core.lang.php
    └── plugins/
        ├── vaultbb_core.php  ← Main plugin file
        └── vaultbb_core/     ← Framework classes

No files should overwrite existing MyBB core files. If your FTP client asks to confirm any overwrites, stop and double-check the paths.

Install the plugin

In your MyBB Admin Control Panel, navigate to:

Admin CP → Configuration → Plugins

Find VaultBB Core in the list and click Install & Activate.

During installation, Core will:

  • Create the vaultbb_logs database table
  • Create the vaultbb_plugins database table
  • Register its own settings group (VaultBB Core) under Configuration → Settings
  • Add a scheduled task (VaultBB Core: Log Cleanup) that runs daily at 03:00
  • Register itself in the plugin registry

Verify the VaultBB tab appears

After activation, a new VaultBB tab will appear in the Admin CP top navigation bar. Click it to open the Dashboard — you should see the system overview card with your PHP and MyBB versions, and a health check confirming both database tables are present.


Database Tables Created

VaultBB Core creates two tables on install:

vaultbb_logs

Stores all activity and error logs generated by Core and every VaultBB plugin.

ColumnTypeDescription
idBIGINT UNSIGNEDAuto-increment primary key
datelineINT UNSIGNEDUnix timestamp of the log entry
uidINT UNSIGNEDMyBB user ID (0 = system/anonymous)
pluginVARCHAR(64)Plugin identifier (e.g. advdice)
actionVARCHAR(64)Action identifier (e.g. plugin_activated)
severityENUMinfo, warning, or error
ipaddressVARBINARY(16)IP address of the actor
dataMEDIUMTEXTJSON-encoded contextual payload

vaultbb_plugins

The central plugin registry — tracks all installed VaultBB plugins.

ColumnTypeDescription
idINT UNSIGNEDAuto-increment primary key
codenameVARCHAR(120)Unique plugin identifier
titleVARCHAR(120)Human-readable plugin name
versionVARCHAR(32)Currently installed version
core_minVARCHAR(32)Minimum Core version required
activeTINYINT(1)Whether the plugin is currently active
installed_datelineINT UNSIGNEDWhen the plugin was first registered
updated_datelineINT UNSIGNEDWhen the registry entry was last updated
last_seenINT UNSIGNEDLast time the plugin was active at runtime
dataMEDIUMTEXTJSON-encoded optional plugin metadata

Scheduled Task

Core installs a daily cleanup task named VaultBB Core: Log Cleanup. It runs at 03:00 every day and deletes log entries older than the configured retention period (default: 90 days).

You can view or adjust the task schedule under Admin CP → Tools & Maintenance → Task Manager.


Updating VaultBB Core

To update to a newer version:

  1. Upload the new UPLOAD/ contents, overwriting existing VaultBB Core files.
  2. In the Admin CP plugins list, deactivate then reactivate VaultBB Core.
  3. Core will automatically run any pending schema upgrades (e.g. adding new columns) via Core::runUpgradesIfNeeded(), which fires on every global_start hook.

You do not need to uninstall to update. Your logs, settings, and plugin registry entries are preserved across deactivate/activate cycles. Only an explicit Uninstall removes the database tables.


Uninstalling VaultBB Core

Uninstalling VaultBB Core will drop the vaultbb_logs and vaultbb_plugins tables, removing all log history and plugin registry data permanently. Deactivate all dependent VaultBB plugins first.

In the Admin CP plugins list, click Uninstall next to VaultBB Core. This will:

  • Drop vaultbb_logs and vaultbb_plugins
  • Remove all VaultBB Core settings and settings group
  • Remove the cleanup scheduled task
  • Remove Update Checker internal settings

On this page