MokoSuiteClient/README.md

<!--
 Copyright (C) 2025 Moko Consulting <hello@mokoconsulting.tech>

 This file is part of a Moko Consulting project.

 SPDX-LICENSE-IDENTIFIER: GPL-3.0-or-later

 # FILE INFORMATION
 DEFGROUP: Joomla.Plugin
 INGROUP: MokoSuiteClient
 REPO: https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient
 VERSION: 02.47.74
 PATH: /README.md
 BRIEF: MokoSuiteClient platform plugin for Joomla
-->

# MokoSuiteClient

[![Version](https://img.shields.io/badge/version-02.03.11-blue.svg?logo=v&logoColor=white)](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/releases)
[![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green.svg?logo=gnu&logoColor=white)](LICENSE)
[![Joomla](https://img.shields.io/badge/Joomla-5.x%20%7C%206.x-red.svg?logo=joomla&logoColor=white)](https://www.joomla.org)
[![PHP](https://img.shields.io/badge/PHP-8.1%2B-777BB4.svg?logo=php&logoColor=white)](https://www.php.net)

MokoSuiteClient is the Joomla 5.x / 6.x client-facing tracker and identity layer for the MokoSuite platform. It provides security hardening, health monitoring, privacy compliance, multi-domain management, and integration with MokoSuiteHQ for centralized site management.

## Features

### Core
- **Admin Dashboard** — site info, plugin status, quick actions, support PIN
- **Health Monitoring** — 15 diagnostic checks via `/?mokosuiteclient=health`
- **Heartbeat** — RSA-signed registration with MokoSuiteHQ, daily support PIN rotation
- **Extension Catalog** — browse and install Moko Consulting extensions

### Security (Firewall Plugin)
- **Web Application Firewall** — SQL injection, XSS, RFI, directory traversal shields
- **Security Headers** — X-Frame-Options, CSP, HSTS, Referrer-Policy, Permissions-Policy
- **IP Management** — trusted IPs, blocklist, auto-ban on WAF threshold
- **Password Policy** — min length, uppercase, number, special character requirements
- **Access Control** — admin secret URL, frontend super user block, upload restrictions

### Privacy Guard
- **GDPR Compliance** — data subject requests, consent logging, retention policies
- **User Data** — export, anonymize, or delete user data on request

### DevTools
- **Development Mode** — debug, cache disable, hit suppression
- **Mirror Domains & Staging** — repeatable table of domain aliases with offline bypass and robots directives
- **Maintenance** — reset hits, delete versions, reset download keys

### Multi-Domain
- **Site Aliases** — per-alias offline mode, robots directives, canonical URLs
- **Offline Bypass** — TOS, privacy policy, and support pages remain accessible when site is offline

### Integration
- **MokoSuiteHQ** — heartbeat, health data, backup status, activity logging
- **MokoSuiteBackup** — bridge plugin discovers BackupStatusHelper for heartbeat payloads
- **Joomla** — guided tours, action logging, custom fields, scheduled tasks

## Requirements

- Joomla 5.0+ or 6.x
- PHP 8.1+ (8.3+ for Joomla 6)

## Installation

Download the latest `pkg_mokosuiteclient-*.zip` from [Releases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/releases) and install via **System → Install → Upload Package File**.

After installation, the package auto-enables and sets protected status.

## Documentation

Full documentation is available on the [MokoSuiteClient Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki):

- [Configuration Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki/Configuration)
- [Health Monitoring](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki/Health-Monitoring)
- [Site Aliases](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki/Site-Aliases)
- [API Endpoints](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki/API-Endpoints)
- [Grafana Integration](https://git.mokoconsulting.tech/MokoConsulting/MokoSuiteClient/wiki/Grafana-Integration)

## License

GPL-3.0-or-later — see [LICENSE.md](LICENSE.md)

## Changelog

See [CHANGELOG.md](CHANGELOG.md)

---

**Moko Consulting** | [Website](https://mokoconsulting.tech) | [Email](mailto:hello@mokoconsulting.tech)