{"id":46453578,"url":"https://github.com/marlintodd2024/minio-whmcs","last_synced_at":"2026-03-06T01:04:27.585Z","repository":{"id":342075951,"uuid":"1171246472","full_name":"marlintodd2024/minio-whmcs","owner":"marlintodd2024","description":"MinIO S3 Cloud Storage Provisioning Module for WHMCS — automated provisioning, bucket management, scoped access keys, usage tracking","archived":false,"fork":false,"pushed_at":"2026-03-04T21:08:44.000Z","size":173,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-04T23:24:41.683Z","etag":null,"topics":["cloud-storage","hosting","minio","object-storage","provisioning","s3","whmcs","whmcs-module"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marlintodd2024.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-03-03T02:46:30.000Z","updated_at":"2026-03-04T21:04:04.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/marlintodd2024/minio-whmcs","commit_stats":null,"previous_names":["marlintodd2024/minio-whmcs"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/marlintodd2024/minio-whmcs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marlintodd2024%2Fminio-whmcs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marlintodd2024%2Fminio-whmcs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marlintodd2024%2Fminio-whmcs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marlintodd2024%2Fminio-whmcs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marlintodd2024","download_url":"https://codeload.github.com/marlintodd2024/minio-whmcs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marlintodd2024%2Fminio-whmcs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30156885,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-05T22:39:40.138Z","status":"ssl_error","status_checked_at":"2026-03-05T22:39:24.771Z","response_time":93,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud-storage","hosting","minio","object-storage","provisioning","s3","whmcs","whmcs-module"],"created_at":"2026-03-06T01:04:27.044Z","updated_at":"2026-03-06T01:04:27.574Z","avatar_url":"https://github.com/marlintodd2024.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ImpulseMinio — WHMCS MinIO Provisioning Module\n\nS3-compatible object storage provisioning module for WHMCS. Automates user creation, bucket management, quota enforcement, and client self-service via the WHMCS client area.\n\n## Features\n\n- **Automated provisioning** — creates MinIO users, buckets, and policies on order activation\n- **Client dashboard** — 6-tab interface: Overview, Buckets, Access Keys, Quick Start, File Browser, Statistics\n- **S3 Connection Details** — endpoint, credentials, plan limits, one-click copy\n- **Object Explorer** — browse, upload (drag-and-drop), download, and delete files directly from WHMCS\n- **Storage Statistics** — interactive Chart.js graphs with 6 metrics, 4 time ranges, and adaptive unit scaling\n- **Bucket management** — create/delete buckets with per-plan limits and namespace isolation\n- **Access key management** — create/revoke service accounts with optional bucket scoping\n- **Versioning toggle** — enable/suspend S3 versioning per bucket (configurable per product)\n- **Quota enforcement** — disk quotas per bucket via MinIO's built-in quota system\n- **Hourly usage tracking** — storage via `mc du`, bandwidth via Nginx log parsing, all 6 metrics via Prometheus\n- **Suspension handling** — disables MinIO user on suspend, re-enables on unsuspend\n- **Storage addons** — automatic disk limit adjustment when addons are purchased\n- **Upgrade/downgrade** — quota updates on plan changes with prorated billing support\n\n## Requirements\n\n- WHMCS 8.x+\n- MinIO server with `mc` CLI installed\n- PHP 7.4+ with `exec()` enabled\n- Python 3 on MinIO server (for bandwidth and Prometheus stats)\n- Lagom client theme (recommended, not required)\n\n## Quick Start\n\nSee [INSTALL.md](INSTALL.md) for full setup instructions.\n\n```\nwhmcs_root/\n├── crons/\n│   └── impulseminio_usage.php              # Hourly usage sync runner\n├── httpdocs/\n│   ├── includes/\n│   │   └── hooks/\n│   │       ├── impulseminio_hooks.php      # Suspension banner + sidebar\n│   │       └── impulseminio_usage_sync.php # Hourly storage + bandwidth sync\n│   └── modules/\n│       └── servers/\n│           └── impulseminio/\n│               ├── impulseminio.php        # Main module (~1725 lines)\n│               ├── hooks.php              # Addon storage hooks\n│               ├── lib/\n│               │   └── MinioClient.php    # mc CLI wrapper (~480 lines)\n│               └── templates/\n│                   └── clientarea.tpl     # Smarty template\n\nMinIO Server:\n├── /usr/local/bin/impulsedrive_bandwidth_stats.py  # Nginx + Prometheus stats\n└── /var/www/impulsedrive-stats/bandwidth.json      # Stats output (JSON)\n```\n\n## Product Configuration\n\n| Option | Field | Description |\n|--------|-------|-------------|\n| configoption1 | Disk Quota (GB) | Storage limit. 0 = unlimited |\n| configoption2 | Bandwidth Limit (GB) | Monthly transfer limit |\n| configoption3 | Max Buckets | Bucket count limit. 0 = unlimited |\n| configoption4 | Max Access Keys | Key count limit. 0 = unlimited |\n| configoption5 | mc CLI Path | Default: `/usr/local/bin/mc` |\n| configoption6 | S3 Endpoint URL | Override auto-detected endpoint |\n| configoption7 | Console URL | Link to MinIO Console (optional) |\n| configoption8 | Bucket Prefix | Custom prefix for bucket names |\n| configoption9 | Reserved | — |\n| configoption10 | Enable Versioning | Allow clients to toggle versioning |\n\n## Usage Tracking \u0026 Statistics\n\nThe module tracks 6 metrics hourly and displays them in the Statistics tab:\n\n| Metric | Source | Description |\n|--------|--------|-------------|\n| Storage Usage | `mc du` | Total bytes stored across all buckets |\n| Downloads | Nginx logs | Egress bytes served to clients |\n| Uploads | Prometheus | Ingress bytes received from clients |\n| Object Count | `mc du` | Total number of objects stored |\n| Inbound Replication | Prometheus | Bytes received via bucket replication |\n| Outbound Replication | Prometheus | Bytes sent via bucket replication |\n\nUsage data is stored in `mod_impulseminio_usage_history` and automatically pruned after 90 days. The Statistics tab supports 4 time ranges (24h, 7d, 30d, 90d) with adaptive Y-axis scaling (B/KB/MB/GB).\n\nSee [INSTALL.md](INSTALL.md) Section 6 for setup instructions.\n\n## Database Tables\n\nAuto-created on first use:\n\n| Table | Purpose |\n|-------|---------|\n| `mod_impulseminio_buckets` | Tracks buckets per service |\n| `mod_impulseminio_accesskeys` | Tracks access keys per service |\n| `mod_impulseminio_usage_history` | Hourly usage snapshots for Statistics tab |\n\n## License\n\nProprietary — Impulse Hosting. See [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarlintodd2024%2Fminio-whmcs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarlintodd2024%2Fminio-whmcs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarlintodd2024%2Fminio-whmcs/lists"}