Files
MokoSuiteClient/README.md
T
jmiller 16ebfabd4e
Cascade Main → Dev / Cascade main → branches (push) Successful in 2s
Repo Health / Access control (push) Successful in 1s
Repo Health / Release configuration (push) Failing after 3s
Repo Health / Scripts governance (push) Successful in 3s
Repo Health / Repository health (push) Failing after 3s
Repository Cleanup / Clean Merged Branches (push) Successful in 5s
Secret Scanning / Gitleaks Secret Scan (push) Successful in 5s
Security Audit / Dependency Audit (push) Successful in 3s
docs: update README from wiki Home
2026-05-10 18:39:21 +00:00

86 lines
4.0 KiB
Markdown

# MokoWaaS
MokoWaaS is a Joomla 5.x / 6.x system plugin that provides a configurable white-label identity layer for the MokoWaaS platform.
![Language](https://img.shields.io/badge/Markdown-000000?style=flat-square&logo=markdown&logoColor=white) ![License](https://img.shields.io/badge/license-GPL--3.0--or--later-green?style=flat-square) ![Wiki](https://img.shields.io/badge/wiki-MokoWaaS-blue?style=flat-square)
Joomla system plugin that powers the Moko Consulting Web-as-a-Service platform -- multi-tenant site management, branding injection, and automated client provisioning.
---
| | |
|---|---|
| **Type** | Joomla System Plugin |
| **Language** | PHP |
| **Joomla** | 5.x |
| **License** | GPL-3.0-or-later |
| **Platform** | [Gitea](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS) (primary) |
---
## Overview
MokoWaaS is the core plugin that transforms a standard Joomla installation into a managed WaaS platform. It handles client site configuration, branding, update management, and integrates with the MokoStandards ecosystem for automated deployment and governance.
---
## Wiki Pages
### Guides
| Page | Description |
|------|-------------|
| [Installation Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-installation-guide) | Prerequisites, Joomla setup, plugin installation |
| [Configuration Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-configuration-guide) | Plugin parameters, client site settings |
| [Build Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-build-guide) | Building the installable package |
| [Operations Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-operations-guide) | Day-to-day management and maintenance |
| [Testing Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-testing-guide) | Testing procedures and validation |
| [Upgrade and Versioning Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-upgrade-and-versioning-guide) | Version management and upgrade paths |
| [Rollback and Recovery Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-rollback-and-recovery-guide) | Disaster recovery and rollback procedures |
| [Troubleshooting Guide](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/guides-troubleshooting-guide) | Common issues and solutions |
### Reference
- [Plugin Overview](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/reference-plugin-overview) -- architecture, event hooks, feature map
- [Plugin Basic](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/plugin-basic) -- plugin structure and manifest
- [Update Server](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki/update-server) -- Joomla update server configuration
---
## Related Wikis
| Repo | Purpose |
|------|---------|
| [Template-Client-WaaS](https://git.mokoconsulting.tech/MokoConsulting/Template-Client-WaaS/wiki) | Client site template (paired with MokoWaaS) |
| [MokoOnyx](https://git.mokoconsulting.tech/MokoConsulting/MokoOnyx/wiki) | Joomla admin template |
| [joomla-api-mcp](https://git.mokoconsulting.tech/MokoConsulting/joomla-api-mcp/wiki) | Joomla Web Services API MCP |
| [deploy-mcp](https://git.mokoconsulting.tech/MokoConsulting/deploy-mcp/wiki) | Git-based deployment MCP |
| [backup-mcp](https://git.mokoconsulting.tech/MokoConsulting/backup-mcp/wiki) | Backup MCP with Akeeba integration |
---
> **[MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki)** -- central standards hub for all Moko Consulting projects.
---
---
## Documentation
Full documentation is available on the [Wiki](https://git.mokoconsulting.tech/MokoConsulting/MokoWaaS/wiki).
## Contributing
See the wiki for development guidelines and contribution instructions.
## License
This project is licensed under the GNU General Public License v3.0 or later -- see the [LICENSE](LICENSE) file.
---
*[Moko Consulting](https://mokoconsulting.tech) -- [MokoStandards](https://git.mokoconsulting.tech/MokoConsulting/moko-platform/wiki/Home)*