docs: rewrite Home from code research -- features, REST API, profiles

2026-06-19 07:18:18 +00:00
parent 4d9b4a08b2
commit cd5db26ae7
2 changed files with 61 additions and 56 deletions
@@ -1,56 +0,0 @@
-# MokoSuiteBackup
-
-Full-site backup and restore for Joomla — database, files, and configuration.
-
-MokoSuiteBackup is a comprehensive backup solution for Joomla 4/5/6 that replaces Akeeba Backup Pro with an in-house, fully integrated package.
-
-## Quick Links
-
- [Installation](Installation)
- [Configuration](Configuration)
- [Backup Profiles](Backup-Profiles)
- [Differential Backups](Differential-Backups)
- [Scheduled Tasks](Scheduled-Tasks)
- [Remote Storage](Remote-Storage)
- [Encryption](Encryption)
- [REST API](REST-API)
- [CLI Usage](CLI-Usage)
- [Akeeba Migration](Akeeba-Migration)
- [Troubleshooting](Troubleshooting)
-
-## Package Contents
-
-| Sub-extension | Type | Purpose |
-|---|---|---|
-| `com_mokobackup` | Component | Admin backend — backup engine, profiles, records, dashboard |
-| `plg_system_mokobackup` | System Plugin | Auto-cleanup of expired backups |
-| `plg_task_mokobackup` | Task Plugin | Joomla Scheduled Tasks integration |
-| `plg_quickicon_mokobackup` | Quickicon Plugin | Dashboard status widget |
-| `plg_webservices_mokobackup` | WebServices Plugin | REST API for remote management |
-| `plg_console_mokobackup` | Console Plugin | CLI commands (run, list, profiles, restore, cleanup) |
-| `plg_content_mokobackup` | Content Plugin | Auto-backup before extension install/update |
-| `plg_actionlog_mokobackup` | Actionlog Plugin | Logs backup actions to User Action Logs |
-
-## Architecture
-
-```
-BackupEngine
-├── Step 1: DatabaseDumper     →  SQL dump (exclude tables)
-├── Step 2: FileScanner        →  Directory walk (exclude dirs/files)
-│           └─ DifferentialScanner  →  Compare against base manifest
-├── Step 1.5: AES-256 Encryption   →  Optional password protection
-├── Step 2.5: MokoRestore Wrapper    →  Self-extracting restore.php
-├── Step 3: RemoteUploader     →  FTP / Google Drive / S3
-│           ├─ FtpUploader
-│           ├─ GoogleDriveUploader
-│           └─ S3Uploader
-├── SHA-256 Checksum           →  Integrity verification
-├── NotificationSender         →  Email on success/failure
-└── Event Dispatcher           →  onMokoBackupAfterRun (actionlog, etc.)
-```
-
-## Requirements
-
- Joomla 4.0+ (4.1+ for Scheduled Tasks)
- PHP 8.1+
- `ext-zip`, `ext-curl`, `ext-ftp`, `ext-mbstring`, `ext-pdo_mysql`
@@ -0,0 +1,61 @@
+# MokoSuiteBackup
+
+Full-site backup and restore for Joomla -- database, files, and configuration with multiple profiles, scheduled backups, and REST API
+
+| Field | Value |
+|---|---|
+| **Type** | Joomla Package (component + system plugin + webservices plugin) |
+| **Version** | 01.23.00 |
+| **Joomla** | 4.x / 5.x / 6.x |
+| **PHP** | 8.1+ |
+| **License** | GPL-3.0-or-later |
+| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteBackup) |
+
+---
+
+## 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
+
+---
+
+## REST API
+
+| 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 |
+
+---
+
+## Installation
+
+1. Download `pkg_mokobackup-*.zip` 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
+
+---
+
+> [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 |