gitea-actions[bot]
56 lines
2.1 KiB
Markdown
56 lines
2.1 KiB
Markdown
# MokoJoomBackup
|
|
|
|
<!-- VERSION: 01.01.07 -->
|
|
|
|
Full-site backup and restore for Joomla — database, files, and configuration.
|
|
|
|
## Overview
|
|
|
|
MokoJoomBackup is a comprehensive backup solution for Joomla 4/5/6 sites. It creates complete site backups including the database, files, and configuration, packaged into downloadable ZIP archives. Supports multiple backup profiles, scheduled backups via CLI/cron, and a REST API for remote management.
|
|
|
|
## Features
|
|
|
|
- Full site backup (database + files + configuration)
|
|
- Database-only backup mode
|
|
- Files-only backup mode
|
|
- Multiple backup profiles with independent configurations
|
|
- File and directory exclusion filters
|
|
- Table exclusion filters for database backups
|
|
- Step-based backup engine (avoids PHP timeout on large sites)
|
|
- CLI script for cron/scheduled backups
|
|
- REST API (Joomla Web Services) for remote management
|
|
- Backup record management (list, download, delete)
|
|
- Automatic old backup cleanup (configurable retention)
|
|
- Admin dashboard with backup history and storage usage
|
|
|
|
## Installation
|
|
|
|
1. Download `pkg_mokobackup-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoJoomBackup/releases)
|
|
2. Joomla Administrator > Extensions > Install
|
|
3. System plugin enabled automatically on install
|
|
|
|
## Configuration
|
|
|
|
- **Component**: Administrator > Components > MokoJoomBackup
|
|
- **Profiles**: Create backup profiles with different file/database filters
|
|
- **System Plugin**: Configure scheduled backup triggers and notifications
|
|
- **CLI**: `php cli/mokobackup.php --profile=1` for cron-based backups
|
|
|
|
## REST API
|
|
|
|
The webservices plugin exposes endpoints compatible with the MokoBackup MCP server:
|
|
|
|
- `POST /api/index.php/v1/mokobackup/backup` — Start a backup
|
|
- `GET /api/index.php/v1/mokobackup/backups` — List backup records
|
|
- `GET /api/index.php/v1/mokobackup/backup/:id/download` — Download archive
|
|
- `DELETE /api/index.php/v1/mokobackup/backup/:id` — Delete backup record
|
|
- `GET /api/index.php/v1/mokobackup/profiles` — List backup profiles
|
|
|
|
## License
|
|
|
|
GPL-3.0-or-later
|
|
|
|
## Author
|
|
|
|
[Moko Consulting](https://mokoconsulting.tech) — hello@mokoconsulting.tech
|