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

docs: update Home — folder nav, all features, ntfy, ACL, config sanitization

Jonathan Miller
2026-06-19 02:46:57 -05:00
parent 4e8afc7a5f
commit 8e20017c78
1 changed files with 75 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Home.md
+75 -33
@@ -1,29 +1,81 @@
# MokoSuiteBackup
Full-site backup and restore for Joomla -- database, files, and configuration with multiple profiles, scheduled backups, and REST API
Full-site backup and restore for Joomla — database, files, and configuration.
| Field | Value |
|---|---|
| **Type** | Joomla Package (component + system plugin + webservices plugin) |
| **Version** | 01.23.00 |
| **Joomla** | 4.x / 5.x / 6.x |
| **Package** | `pkg_mokosuitebackup` |
| **Type** | Joomla Package (8 sub-extensions) |
| **Joomla** | 6.x+ |
| **PHP** | 8.1+ |
| **License** | GPL-3.0-or-later |
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup) |
| **Repo** | [MokoSuiteBackup](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup) |
---
## Guides
- [Installation](guides/Installation) — Download, install, and configure
- [Configuration](guides/Configuration) — Component settings, profiles, dashboard
- [Backup Profiles](guides/Backup-Profiles) — Create and manage backup profiles
- [Scheduled Tasks](guides/Scheduled-Tasks) — Automate backups with Joomla scheduler
- [CLI Usage](guides/CLI-Usage) — Command-line backup and management
- [Akeeba Migration](guides/Akeeba-Migration) — Migrate from Akeeba Backup Pro
## Reference
- [REST API](reference/REST-API) — Remote backup management endpoints
- [Remote Storage](reference/Remote-Storage) — FTP, S3, Google Drive upload
- [Encryption](reference/Encryption) — AES-256 archive encryption
- [Differential Backups](reference/Differential-Backups) — Incremental backup strategy
- [Troubleshooting](guides/Troubleshooting) — Common issues and solutions
---
## Features
- Full site backup (database + files + configuration)
- Database-only and files-only backup modes
- Multiple backup profiles with independent configurations
- File/directory and table exclusion filters
- Step-based backup engine (avoids PHP timeout on large sites)
- CLI script for cron/scheduled backups
- REST API for remote management (compatible with mcp-mokobackup MCP server)
- Automatic old backup cleanup (configurable retention)
- Admin dashboard with backup history and storage usage
### Backup Types
- Full site (database + files + configuration)
- Database-only and files-only modes
- Differential — only files changed since last full backup
### Archive Formats
- ZIP with optional AES-256 encryption
- tar.gz for maximum compatibility
- Configurable naming with date/host/profile placeholders
### Scheduling & Automation
- Joomla Scheduled Tasks integration
- Web cron endpoint for shared hosting
- Pre-action backups — auto-backup before extension update or uninstall
- CLI: `php cli/joomla.php mokosuitebackup:run --profile=1`
### Remote Storage
- FTP / FTPS with passive mode
- Amazon S3 (and S3-compatible: DigitalOcean Spaces, Wasabi, MinIO)
- Google Drive with OAuth2 and resumable uploads
### Notifications
- Email on success and/or failure per profile
- ntfy push notifications — instant alerts to phone or desktop
- Per-profile topic, server, and access token configuration
### Security
- Granular ACL permissions — separate run, download, and restore
- Configuration sanitization — credentials stripped from backups
- MokoRestore security gate — filesystem verification before restore
- Abstract DB prefix for cross-server portability
### Restore
- In-admin restore with file and database options
- MokoRestore standalone wizard — works without Joomla installed
- Configuration rebuild from backup template + fresh credentials
- Admin password reset and client provisioning
### Per-Profile Management
- Unlimited profiles with independent settings
- Per-profile retention (days + count)
- Per-profile exclusions and notifications
---
@@ -31,31 +83,21 @@ Full-site backup and restore for Joomla -- database, files, and configuration wi
| Endpoint | Description |
|---|---|
| `POST /api/v1/mokobackup/backup` | Start a backup |
| `GET /api/v1/mokobackup/backups` | List backup records |
| `GET /api/v1/mokobackup/backup/:id/download` | Download archive |
| `DELETE /api/v1/mokobackup/backup/:id` | Delete backup record |
| `GET /api/v1/mokobackup/profiles` | List backup profiles |
| `POST /api/v1/mokosuitebackup/backup` | Start a backup |
| `GET /api/v1/mokosuitebackup/backups` | List backup records |
| `GET /api/v1/mokosuitebackup/backup/:id/download` | Download archive |
| `DELETE /api/v1/mokosuitebackup/backup/:id` | Delete backup record |
| `GET /api/v1/mokosuitebackup/profiles` | List backup profiles |
---
## Installation
## Quick Start
1. Download `pkg_mokobackup-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup/releases)
1. Download from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup/releases)
2. Install via Extensions > Install
3. System plugin auto-enabled on install
4. CLI: `php cli/mokobackup.php --profile=1` for cron backups
3. Components > MokoSuiteBackup > Backup Now
4. Configure notifications in profile settings
---
> [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/mokoplatform/wiki/Home)
---
*Repo: [MokoSuiteBackup](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup) · [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/mokoplatform/wiki/Home)*
| Revision | Date | Author | Description |
|---|---|---|---|
| 2.0 | 2026-06-19 | Moko Consulting | Rewrite from code research -- features, REST API, profiles |
| 1.1 | 2026-06-18 | Moko Consulting | Fix repo name, URLs |
| 1.0 | 2026-05-09 | Moko Consulting | Initial version |