Getting Started

Details

Category: Getting Started

• Applicable Software: MokonyxBackup
• Min Version Number: 01.00.01
• Max Version Number: Not Applicable

Get MokonyxBackup up and running in minutes: install the single package (it drops in the component, plugins, admin module and CLI in one step), run the required tuning wizard, and take your first full-site backup. This guide walks you through requirements, package contents, and the Super-User options worth enabling on day one.

Installation

1. Download the latest pkg_mokonyxbackup-*.zip package from Releases
2. Go to System > Install > Extensions in the Joomla Administrator
3. Upload the package ZIP (or use Install from Folder / Install from URL)
4. The single package installs the component, all plugins, the admin module and the CLI/Web Services resources in one step, and auto-enables its plugins
5. Wait for the postflight to complete — the installer verifies that every bundled child extension actually registered and that the component's schema tables exist, and reports an error rather than a false "installed successfully" message if anything is missing. The installer also self-heals a missing update site, so future releases arrive through the normal Joomla updater

First Run: Run the Tuning Wizard (Required)

After a fresh install, MokonyxBackup marks its execution tuning as pending. While it is pending, both interactive (UI) backups and pre-action backups (pre-update / pre-install / pre-uninstall) do not run — the run-backup screen shows a modal and the Dashboard shows a reminder banner. Before your first backup:

1. Open Components > MokonyxBackup > Options > Execution Tuning.
2. Click Run tuning wizard. It probes the host (PHP time and memory limits, disk I/O, site file footprint) and fills in the host-wide tuning values.
3. Review the suggested values and click Save. This persists the values and clears the pending flag; backups are now unblocked.

Note: the wizard is flagged pending only on a fresh install — it is not re-armed on every update — and updates are never blocked. If the host changes later, use the Reset tuning wizard button to re-arm it. See MokonyxBackup Execution Tuning for full detail.

Package Contents

Extension	Type	Purpose
com_mokonyxbackup	Component	Admin backend with backup engine, profiles, records and content snapshots
plg_system_mokonyxbackup	System Plugin	Auto-cleanup, web-cron endpoint, and backup-before-update/uninstall protection
plg_task_mokonyxbackup	Task Plugin	Joomla Scheduled Tasks integration (backup profile & content snapshot)
plg_quickicon_mokonyxbackup	Quickicon Plugin	Dashboard status widget
plg_console_mokonyxbackup	Console Plugin	CLI commands (run, list, profiles, restore, cleanup, snapshot)
plg_content_mokonyxbackup	Content Plugin	Automatic pre-install backups
plg_actionlog_mokonyxbackup	Action Log Plugin	Logs profile and backup actions to Joomla action logs
plg_webservices_mokonyxbackup	WebServices Plugin	REST API for the MCP server
mod_mokonyxbackup_cpanel	Admin Module	Control-panel quick-access module

Requirements

• Joomla 6.x or later
• PHP 8.1 or later (the standalone MokonyxRestore script requires PHP 8.3+)
• MySQL 8.0 or MariaDB
• PHP extensions: ext-zip, ext-curl, ext-ftp, ext-mbstring, ext-pdo_mysql

First Backup

1. Navigate to Components > MokonyxBackup (the admin Backup menu, with Dashboard, Backup Records, Content Snapshots and Backup Profiles)
2. A default backup profile is pre-configured
3. Run the tuning wizard (see above) if you haven't yet — backups are blocked until you do
4. Open Dashboard, select the profile from the dropdown and click Backup Now
5. A full-screen backup screen runs the stepped backup with a real-time progress bar; on completion a View backup record button links to the new record

Post-Install Options

Several capabilities are Super User only and off by default. Open Components > Backup > Options to enable Backup before update / Backup before uninstall, Allow Snapshot Injection (on a receiving/slave site), confirm the Default profile and backup directory, and set email/ntfy notifications. Out of the box the default backup directory is placed one level above the web root, so backups are never web-accessible and can't be swept into the backup itself.

Documentation

Full documentation is on the MokonyxBackup Wiki.

Last Updated: September 02, 2026

Hits: 17