MokoConsulting/MokoSuiteBackup
1
0
Fork 0
Code Issues 28 Pull Requests Releases 2 Wiki Activity

Update "Installation"

Jonathan Miller
2026-06-29 16:37:43 +00:00
parent e4fe5263f2
commit 6b6b0631a5
2 changed files with 71 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Installation.md
+71
@@ -0,0 +1,71 @@
# Installation
## Requirements
- Joomla 6.x or later
- PHP 8.3 or later
- MySQL 8.0+ or MariaDB 10.6+
## Download
Download the latest `pkg_mokosuitebackup-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup/releases).
## Install
1. Log in to Joomla Administrator
2. Go to **System > Install > Extensions**
3. Upload `pkg_mokosuitebackup-*.zip`
4. The package will install all nine sub-extensions and MokoSuiteClient automatically
## Package Contents
| Extension | Type | Purpose |
|---|---|---|
| `com_mokosuitebackup` | Component | Core backup/restore engine, admin UI, dashboard |
| `plg_system_mokosuitebackup` | Plugin (System) | Automated cleanup, webcron endpoint |
| `plg_task_mokosuitebackup` | Plugin (Task) | Scheduled backups and snapshots via com_scheduler |
| `plg_quickicon_mokosuitebackup` | Plugin (Quick Icon) | Dashboard backup status widget |
| `plg_webservices_mokosuitebackup` | Plugin (Web Services) | REST API route registration |
| `plg_console_mokosuitebackup` | Plugin (Console) | CLI commands for backup, restore, snapshot |
| `plg_content_mokosuitebackup` | Plugin (Content) | Auto-backup before extension updates/uninstalls |
| `plg_actionlog_mokosuitebackup` | Plugin (Action Log) | User action audit logging |
| `mod_mokosuitebackup_cpanel` | Module (Admin) | CPanel dashboard module with quick actions |
| MokoSuiteClient | Package | Bundled admin dashboard, firewall, tenant tools |
## Auto-enabled Plugins
On fresh install, all plugins are enabled automatically.
## Post-install
1. Navigate to **Components > MokoSuiteBackup**
2. The dashboard shows backup status, system health, and quick actions
3. The default backup profile is pre-configured
4. Review the default profile settings under **Backup Profiles**
5. Run your first backup using the **Backup Now** button on the dashboard
## Update Server
MokoSuiteBackup uses the MokoGitea update server. Updates appear automatically in **System > Update > Extensions**.
Update server URL:
```
https://git.mokoconsulting.tech/api/packages/MokoConsulting/generic/MokoSuiteBackup/latest/updates.xml
```
This is configured automatically in the package manifest — no manual setup is required.
## Backup Directory
Backups are stored in `administrator/components/com_mokosuitebackup/backups/` by default. This directory is:
- Protected with `.htaccess` (Deny from all)
- Contains an `index.html` to prevent directory listing
- Configurable per profile
## Uninstall
1. Go to **System > Manage > Extensions**
2. Search for "MokoSuiteBackup"
3. Select the package and click **Uninstall**
4. All sub-extensions and database tables will be removed
5. Backup archives in the backup directory are **not** automatically deleted
guides/Installation.md
-50
@@ -1,50 +0,0 @@
# Installation
## Download
Download the latest `pkg_mokobackup-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup/releases).
## Install
1. Log in to Joomla Administrator
2. Go to **System > Install > Extensions**
3. Upload `pkg_mokobackup-*.zip`
4. The package will install all eight sub-extensions automatically
## Auto-enabled Plugins
On fresh install, these plugins are enabled automatically:
- System - MokoSuiteBackup (backup cleanup)
- Task - MokoSuiteBackup (scheduled tasks)
- Quick Icon - MokoSuiteBackup (dashboard widget)
- Web Services - MokoSuiteBackup (REST API)
- Console - MokoSuiteBackup (CLI commands)
- Content - MokoSuiteBackup (auto-backup before extension updates)
- Action Log - MokoSuiteBackup (user action logging)
## Post-install
1. Navigate to **Components > MokoSuiteBackup**
2. The dashboard shows backup status, system health, and quick actions
3. The default backup profile is pre-configured
4. Review the default profile settings under **Backup Profiles**
5. Run your first backup using the **Backup Now** button on the dashboard
## Migrating from Akeeba Backup Pro
If Akeeba Backup Pro is installed, see [Akeeba Migration](Akeeba-Migration) for one-click profile and history import.
## Backup Directory
Backups are stored in `administrator/components/com_mokobackup/backups/` by default. This directory is:
- Protected with `.htaccess` (Deny from all)
- Contains an `index.html` to prevent directory listing
- Configurable per profile
## Uninstall
1. Go to **System > Manage > Extensions**
2. Search for "MokoSuiteBackup"
3. Select the package and click **Uninstall**
4. All sub-extensions and database tables will be removed
5. Backup archives in the backup directory are **not** automatically deleted