ditogit / ci4-agent

v1.0.5 2026-09-08 03:59 UTC

Requires

• php: ^8.3
• codeigniter4/framework: ^4.4

Requires (Dev)

• mikey179/vfsstream: ^1.6
• phpunit/phpunit: ^10.5 || ^11.0

MIT

• monitoring
• maintenance
• Agent
• codeigniter4
• CI4

Published on Packagist.org on 2026-09-08 03:59 UTC

README

Lightweight, secure, versioned REST API agent for every CodeIgniter 4 app — standardized monitoring & maintenance for CI4 Project Hub.

Install

composer require ditogit/ci4-agent
php spark maintenance:install

Publishes app/Config/Maintenance.php, appends MAINTENANCE_API_KEY/SECRET to .env, migrates maintenance_audit_logs.

Manual Install (cPanel / No CLI)

Jika tidak ada akses SSH/CLI:

1. Download zip dari Releases, extract ke vendor/ditogit/ci4-agent via File Manager
2. Tambah di app/Config/Autoload.php: 'MaintenanceAgent' => ROOTPATH.'vendor/ditogit/ci4-agent/src'
3. Upload public/maintenance_installer.php dari package ke public/maintenance_installer.php
4. Edit file, ganti INSTALLER_TOKEN dengan random 32 char
5. Buka browser: https://domain.com/maintenance_installer.php?token=TOKEN_KAMU
6. Installer akan: publish app/Config/Maintenance.php, generate MAINTENANCE_API_KEY/SECRET ke .env, patch app/Config/Routes.php & app/Config/Filters.php, migrate maintenance_audit_logs (fallback raw SQL jika Forge gagal)
7. Simpan credentials yang tampil, klik Hapus installer atau hapus manual — wajib hapus setelah selesai
8. Jika DB gagal, import manual via phpMyAdmin:

CREATE TABLE IF NOT EXISTS `maintenance_audit_logs` (
  `id` INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
  `request_id` VARCHAR(64) NULL,
  `action` VARCHAR(64) NOT NULL,
  `status` VARCHAR(32) NOT NULL,
  `affected_rows` INT DEFAULT 0,
  `ip_address` VARCHAR(45) NULL,
  `metadata` TEXT NULL,
  `created_at` DATETIME NULL,
  KEY `action` (`action`), KEY `created_at` (`created_at`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Configure (.env)

MAINTENANCE_ENABLED=true
MAINTENANCE_API_KEY=project_xxx
MAINTENANCE_API_SECRET=yyy
MAINTENANCE_ENVIRONMENT=production
MAINTENANCE_SESSION_STATS=true
MAINTENANCE_SESSION_CLEANUP=true
MAINTENANCE_SESSION_CLEAR=false
MAINTENANCE_DATABASE_STATS=true
MAINTENANCE_STORAGE_STATS=true
MAINTENANCE_CACHE_CLEAR=true
MAINTENANCE_LOG_VIEWER=true
MAINTENANCE_BACKUP=false
MAINTENANCE_QUEUE=false
MAINTENANCE_IP_ALLOWLIST=
MAINTENANCE_SESSION_CLEANUP_BATCH=5000
MAINTENANCE_SESSION_CLEANUP_TIMEOUT=30

API

Prefix /api/v1/maintenance — HMAC auth required.

Method	Path	Permission
GET	/health	maintenance.health.read
GET	/info	maintenance.info.read
GET	/session/stats	maintenance.session.read
POST	/session/cleanup	maintenance.session.cleanup
POST	/session/clear	maintenance.session.clear
GET	/database	maintenance.database.read
GET	/storage	maintenance.storage.read
POST	/cache/clear	maintenance.cache.clear
GET	/logs	maintenance.logs.read
POST	/logs/clear	maintenance.logs.clear
POST	/backup	maintenance.backup.create
GET	/queue	maintenance.queue.read
POST	/queue/retry	maintenance.queue.retry
POST	/queue/clear	maintenance.queue.clear

Headers:

X-Maintenance-Key: project_abc123
X-Maintenance-Timestamp: 1788820000
X-Maintenance-Nonce: random
X-Maintenance-Signature: HMAC-SHA256(timestamp+nonce+METHOD+path+body, secret)

CLI

php spark maintenance:status
php spark maintenance:enable
php spark maintenance:disable
php spark maintenance:rotate-key

Emergency disable: MAINTENANCE_ENABLED=false → 503.

Security

• HMAC-SHA256, ±5min clock skew, nonce replay guard, IP allowlist, rate limit (60/10/5 req/min), feature flags, audit log.

License

MIT